ST SPWF04S Series User Manual

Page 1

UM2114

User manual

TCP/IP protocol stack for SPWF04Sx Wi-Fi modules

Introduction

The SPWF04Sx series of Wi-Fi modules integrate a complete TCP/IP protocol stack and a rich set of applications including, but not limited to, web server, web client RESTful API, TFTP, MQTT and SMTP.

Security is added in the multiple layers of Wi-Fi and peer-to-peer protocols. The stack implements the WPS protocol, WPA2 in both the Personal and Enterprise options, and the TLS for end-to-end secure transactions.

Users access the features of the SPWF04Sx modules via UART using the simple AT command syntax, or via SPI using a custom packet format and protocol.

To enable a complete customization of the application on the module, the SPWF04Sx software integrates a MicroPython interpreter that provides the user with MicroPython standard libraries and a customized set of classes to export the specific SPWF04Sx features.

The diagram below summarizes the possible integrations of an SPWF04Sx module in a target application.

Figure 1. SPWF04Sx user integration modes

This user manual is intended as a guide to the set of commands available on the UART or the SPI console. A description and explanation of the configuration variables, status variables and asynchronous indication messages is available in the Appendix of the manual.

This manual is not intended as a technical guide of Wi-Fi and TCP/IP, or other technologies available in the module.

UM2114 - Rev 3 - November 2018 For further information contact your local STMicroelectronics sales office.

www.st.com

Page 2

SPWF04Sx software architecture description

1 SPWF04Sx software architecture description

The complete SW architecture of SPWF04S is shown in the diagram below.

Figure 2. SPWF04Sx software architecture

UM2114

A block diagram of the SPWF04Sx protocol stack is provided in Figure 3. SPWF04Sx protocol stack diagram.

UM2114 - Rev 3

page 2/66

Page 3

SPWF04Sx software architecture description

Figure 3. SPWF04Sx protocol stack diagram

UM2114

UM2114 - Rev 3

page 3/66

Page 4

2 Interface and message types

As shown in Figure 1. SPWF04Sx user integration modes, the SPWF04Sx enables three options for integration of the device in the final user application. Refer to the SPWF04Sx datasheet for information useful for implementation, such as the pinout. The configuration variable, “console_enabled”, is used to define the module interface to use.

• UART interface

“console_enabled=1”

The UART console provides a user-friendly interface built on a set of AT commands that allow an external microcontroller connected to the SPWF04Sx UART to access the functions integrated in SPWF04Sx device. UART is set as the module's default interface.

• SPI interface

“console_enabled=0”

The device can be connected as a slave to the SPI interface of an external microcontroller. An ad hoc SPI protocol and corresponding packet format are defined.

• MicroPython scripting

"console_enabled=2” - to use Python together with AT commands over UART.

"console_enabled=3” - to use MicroPython only.

The device implements a scripting methodology based on an integrated MicroPython interpreter. MicroPython scripts can map a target application, making it unnecessary to integrate the device with an external processor.

The following four message types represent the type of data exchanged over the interfaces.

• Commands

Used to activate a feature defined within the stack. The list of commands supported is specified in

Table 1. SPWF04Sx commands.

• Command return messages

Synchronous messages that report the status of the execution of a command. The list of synchronous error codes is reported in Section 8 in the Appendix.

• WINDs

Asynchronous messages reporting a network or radio status at the application level. The list of WIND messages is reported in Section 8 in the Appendix.

• Data

Data sent to, or received (data payload) from, a remote device.

UM2114

Interface and message types

UM2114 - Rev 3

Table 1. SPWF04Sx commands

Command ID

Utils: commands for debugging and retrieving module status

0x01 AT Null command

0x02 AT+S.HELP Help command

0x05 AT+S.STS Status configuration

0x35 AT+S.PEERS Peers configuration

Management: commands for module management and configuration

0x03 AT+S.RESET SW reset

0x04 AT+S.PMS Set power mode

0x08 AT+S.PYTHON Enter MicroPython execution

0x09 AT+S.GCFG Read Configuration status

AT command Description

page 4/66

Page 5

Command ID AT command Description

0x0A AT+S.SCFG Set configuration variables

0x0B AT+S.WCFG Save configuration to Flash

0x0C AT+S.FCFG Restore factory configuration

0x57 AT+S.FSWRITE FS update via serial UART/SPI

0x58 AT+S.FSUPDATE FS download

0x56 AT+S.FWUPDATE FW download

STM32 peripherals: commands to manage the peripherals and related values

0x13 AT+S.GPIOC Configure GPIO

0x14 AT+S.GPIOR Read GPIO

0x15 AT+S.GPIOW Write GPIO

0x16 AT+S.DAC Disable/Enable DAC

0x17 AT+S.ADC Read ADC value

0x18 AT+S.PWM Set PWM

0x11 AT+S.TIME Get/Set time

0x12 AT+S.RANDOM Provide random number

File system management

0x21 AT+S.FSM Mount volume

0x22 AT+S.FSU Umount/Erase volume

0x23 AT+S.FSC Create file, append data

0x25 AT+S.FSD Delete file

0x26 AT+S.FSR Rename file

0x27 AT+S.FSL List existing files

0x28 AT+S.FSP Print file content

0x29 AT+S.HASH Compute digest

Security: commands to interact with the security features

0x2A AT+S.WPAECERT Manage WPA-Enterprise certificates

0x2B AT+S.TLSCERT Manage TLS certificates

0x36 AT+S.WPS Initiate a WPS Exchange

Radio: commands to manage main Wi-Fi operations

0x32 AT+S.WIFI Set Wi-Fi radio

0x33 AT+S.SCAN Network scan

0x34 AT+S.SSIDTXT Get/Set ASCII SSID

0x39 AT+S.PING Ping a specified host

Sockets: commands to manage socket read and write

0x41 AT+S.SOCKON Open a socket client

0x42 AT+S.SOCKQ Query a socket client for pending data

0x43 AT+S.SOCKC Close a socket client

0x44 AT+S.SOCKW Write data to a socket server

0x45 AT+S.SOCKR Read data from a socket client

0x46 AT+S.SOCKL List opened socket clients

UM2114

Interface and message types

UM2114 - Rev 3

page 5/66

Page 6

Interface and message types

Command ID AT command Description

0x47 AT+S.SOCKDON Open a socket server

0x48 AT+S.SOCKDQ Query socket server for pending data

0x49 AT+S.SOCKDC Close a socket server

0x4A AT+S.SOCKDW Write data to a socket server

0x4B AT+S.SOCKDR Read data from a socket server

0x4C AT+S.SOCKDL List bound socket clients

Web sockets

0x61 AT+S.WSOCKON Open a web socket client

0x62 AT+S.WSOCKQ Query a web socket client for pending data

0x63 AT+S.WSOCKC Close web socket client

0x64 AT+S.WSOCKW Write data to a web socket client

0x65 AT+S.WSOCKR Read data from web socket client

0x66 AT+S.WSOCKL List open web socket client

Trivial FTP

0x51 AT+S.TFTPGET Get request to a TFTP server

0x52 AT+S.TFTPPUT Put request to a TFTP server

SMTP

0x53 AT+S.SMTP Send an email

HTTP

0x54 AT+S.HTTPGET Get a request to an HTTP server

0x55 AT+S.HTTPPOST Post request to an HTTP server

0x59 AT+S.INPUTSSI Fill buffer for raw text input SSI

MQTT

0x5A AT+S.MQTTCONN MQTT connect

0x5B AT+S.MQTTSUB MQTT subscribe

0x5C AT+S.MQTTPUB MQTT publish

0x5D AT+S.MQTTUNSUB MQTT unsubscribe

0x5E AT+S.MQTTDISC MQTT disconnect

UM2114

UM2114 - Rev 3

page 6/66

Page 7

3 AT commands over the UART

The factory module configuration sets the UART console mode as the default interface for the SPWF04Sx. This corresponds to the configuration variable “console_enabled” being set to 1.

AT commands over the UART have a max length of 512 bytes; they are case insensitive and are always in the form of:

AT+S. <cmd-parameters><cr>[data]

Note: Any command requiring data after the <cr> is not reentrant. If bytes are lost during data transfer over the

UART, the module remains in the waiting stage for incoming bytes.

A command is followed by a variable number of response lines that have the following format:

AT-S. <response-string><optional-parameters>

The AT command line, up to the terminating <cr>, is sent from the host. Response lines are sent from the module to the host.

AT-S.OK:<free_heap>:<wifi_state>

AT-S.ERROR:<error-code>:<error-string>

UM2114

AT commands over the UART

returned when a command is successfully executed.

Note that free_heap and wifi_state are shown depending on the "console_verbose" configuration variable value (0 to 2).

qualifies a synchronous error. The <error-code> field of each asynchronous indication type is unique. The descriptive string may be safely ignored.

Note that error_code and error_string are shown depending on the "console_errs" configuration variable value (0 to 2).

Command parameters

A command can require parameters that follow an “=” character. The parameters are positional and separated by a configurable separator (by default, a comma).

Parameters can require mandatory or optional values. In the latter case, if the value is not specified a default value will be used. In the format of the command, an optional parameter is represented in squared brackets.

Asynchronous indications

Asynchronous indications may arrive at any time (except as noted below), and have the format:

+WIND:<number>:<descriptive-string>[:<variables>]<cr><lf>

The <number> field of each asynchronous indication type is unique. The descriptive string may be safely ignored.

Note that number and descriptive strings are shown depending on the "console_winds" configuration variable value (0 to 2).

Refer to Section 8 in the Appendix for a complete list of WIND messages.

Note: Immediately after reset, no commands should be sent and only asynchronous indications are present until the indication “+WIND:0:Console active<cr><lf>” is received. After this event, AT commands may be safely sent to the device.

UM2114 - Rev 3

page 7/66

Page 8

4 SPI protocol

By setting to 0 the configuration variable "console_enabled", the module is enabled to use the SPI interface in place of the UART.

The data transferred over the MISO and MOSI signals are packed using a well-defined API packet format as represented below.

UM2114

SPI protocol

Figure 4. SPI packet formats

Table 2. KindOfEvent Byte SubField

Bits 0:3

Bits 4:7

Bits

Status variable wifi_state values range. Refer to

Table 8. Status variables.

Allowed values are:

• 0x01 for common indications like WIND or action confirmations

• 0x02 for critical error notifications

• 0x03 for incoming data sent over the SPI (in this case normally data are filled into payload field)

Event type

Table 3. Indication number field

Event type Bits 4:7

0x01 Refer to Table 14. WIND messages.

0x02

0x03 Data payload.

Refer to Table 10. AT-S.ERROR:=ERROR ID= =ERROR

String=.

Indication number

Commands over the SPI have a max length of 512 bytes.

To map an AT command in the equivalent SPI command, the following procedure applies:

1. Use the corresponding CMD ID specified in Table 1. SPWF04Sx commands and fill the 4th bytes of the master packet.

2. If optional parameters are available, count the number of comma-separated items after the “=” character and with that number the 6th byte of the message. Starting from the 7th byte, start to write 1 byte containing the

field lengths and then copy the field bytes. Then continue with the remaining parameters.

UM2114 - Rev 3

page 8/66

Page 9

UM2114

SPI protocol

3. Once the full payload has been filled, calculate the full message payload lengths and accordingly fill bytes 1 and 2 in the SPI message packet request.

First example

AT command: AT+S.FSL

1. Command ID: 0x25

2. Number of parameters: 0x00

3. Full message payload length: 0x02

Result: SPI message 0x02 0x00 0x02 0x25 0x00

Second example

AT command: AT+S.SCAN=d,/scan.txt

1. Command ID: 0x33

2. Number of parameters: 0x02

a. First Parameter: 0x01,d

b. Second Parameter: 0x09,"/scan.txt"

3. Full message payload length: 0x0D

Result: SPI Message 0x02 0x00 0x0D 0x33 0x02 0x01 d 0x09 "/scan.txt"

Third example

AT command: AT+S.SOCKW=0,5<Cr>hello

1. Command ID: 0x44

2. Number of parameters: 0x02

a. First Parameter: 0x01,0

b. Second Parameter: 0x01,5

3. Payload: "hello"

Result: SPI Message 0x02 0x00 0x0B 0x44 0x02 0x01 0 0x01 5 "hello"

Fourth example

Asynchronous event: +WIND:1:Poweron:170726-b7ac1ba-SPWF04S

1. kind of event (4bits): 0x01

2. wifi_state (4 bits): 0x0

3. Indication number: 0x01

4. Full message payload length: 0x16

Result: SPI Message 0x02 0x10 0x01 0x16 0x00 (170726-b7ac1ba-SPWF04S)

UM2114 - Rev 3

page 9/66

Page 10

5 MicroPython scripting

The SPWF04Sx supports the MicroPython modes represented in Figure 5. MicroPython modes. The configuration variable “console_enabled” identifies the use of the console together with MicroPython. In detail:

• "console_enabled" set to 2: this setting allows using both AT commands over the UART and MicroPython REPL shell.

• "console_enabled" set to 3: this setting allows only a MicroPython preloaded script to be executed. No UART/SPI communication is allowed to/from a host processor.

Consequently, the following Python modes are defined:

• Python Interactive Console (REPL – Read Evaluation Print Loop). Mainly used for debugging purposes, it is activated by the AT+S.Python (Python command) launched without parameters. The REPL is exited by using a CTRL-D escape character.

• Run Time Script execution. Activated with the Python command, it allows to execute the script specified as parameter. After script execution, control returns to the AT console.

• DefaultScript Hard Execution. By using the GPIO(8) set to high at boot time, or when "console_enabled" is set to 3, the module automatically enters the execution of the script specified by the variable “python_script”. This mode allows the use of the module without a connected host. Note that "console_enabled" is not changed by GPIO(8) access: this means that on the subsequent reboot, accessing Python mode again will require GPIO(8) to be high.

UM2114

MicroPython scripting

Figure 5. MicroPython modes

UM2114 - Rev 3

page 10/66

Page 11

6 Command reference guide

This section details each of the SPWF04Sx commands listed in Table 1. SPWF04Sx commands, including a brief description of its behavior and complete list of parameters. Examples and syntax are described in the “AT” format introduced in Section 3 AT commands over the UART. The mapping mechanism described in Section 4 SPI

protocol is used to map the AT command in the packet format used by the SPI.

6.1 AT

AT, by itself, is a null command that always returns an OK result code. It is useful for testing the module interface for readiness.

Usage:

AT<cr>

UM2114

Command reference guide

Parameters:

None

6.2 AT+S.HELP

AT+S.HELP prints the list of all the AT commands supported with a brief help text for each of them. Refer to

Table 1. SPWF04Sx commands for a complete list of the commands available.

Usage:

1) AT+S.HELP<cr>

2) AT+S.HELP=<keyword><cr>

Parameters:

Result:

to get the full list of commands

to get the list of commands containing the specified keyword

Specifies the name of a keyword

AT-S.Command:<command> -- <help>

<help>

6.3 AT+S.STS

AT+S.STS displays the current values of all the status variables.

UM2114 - Rev 3

Specifies the command

Specifies the description of the command

page 11/66

Page 12

Usage:

UM2114

AT+S.PEERS

1) AT+S.STS<cr>

2) AT+S.STS=<variable><cr>

Parameters:

Result:

AT-S.Var:<var>=<value>

<var>

<value>

6.4 AT+S.PEERS

AT+S.PEERS displays the current values of the peer table. These values are useful to obtain additional information about the module connected to the AP or about the client connected to the module when it is configured in Mini AP mode.

Usage:

to get the full list of configuration variables

to get the value of the specified variable

Specifies the name of a variable. See Table 8. Status

variables for a list of the available status variables

Specifies the status variable name

Specifies the status variable value

1) AT+S.PEERS<cr>

2) AT+S.PEERS=<peer_number><cr>

3) AT+S.PEERS=<peer_number>,<peer_var><cr>

Parameters:

<peer_number>

<peer_var>

Result:

AT-S.Var:<id>.<var>=<value>

<id>

returns the list of peers variable

returns the list of peers variable for the peer_number peer

returns the specific value of a peer_variable

identifier of the peer

displays the current value of the specified peer variable. Refer to Table 9. Peer variables in the Appendix for a complete list of the peer variables

Specifies the peer number

UM2114 - Rev 3

page 12/66

Page 13

UM2114

AT+S.RESET

<var>

<value>

6.5 AT+S.RESET

Command used to provide a SW reset to the module.

Usage:

AT+S.RESET<cr>

Parameters:

None

6.6 AT+S.PMS

The SPWF04Sx features different power states as a consequence of the different operating modes of the radio and the STM32 microcontroller. This command is used to manage the module power state.

The table that follows summarizes the power state conditions supported by the module. The values of the variables affecting the output of the command are also reported in the following table.

Specifies the peer variable name

Specifies the peer variable value

Table 4. Power states and configuration

Module state <Mode> option value STM32 state WLAN state AT variable default values

Rx Idle

Active 0 Run

(1)

PowerSave

(1)

Sleep

StandBy

1. Variables wifi_beacon_wakeup, wifi_operational_mode, and wifi_listen_interval, need to be set to the desired value.

2. The variable standby_time to be set to the desired value.

(2)

1 Run PS or Fast PS

2 Stop PS or Fast PS

3 Standby Off

Rx Active

Tx Active

AT+S.SCFG=sleep_enabled,0

AT+S.SCFG=wifi_powersave,0

AT+S.SCFG=standby_enabled,0

AT+S.SCFG=sleep_enabled,0

AT+S.SCFG=standby_enabled,0

AT+S.SCFG=wifi_powersave,1

AT+S.SCFG=sleep_enabled,1

AT+S.SCFG=standby_enabled,0

AT+S.SCFG=wifi_powersave,1

AT+S.SCFG=standby_enabled,1

AT+S.SCFG=sleep_enabled,0

Usage:

AT+S.PMS=[<mode>]<cr>

UM2114 - Rev 3

Parameters:

page 13/66

Page 14

<mode>

6.7 AT+S.PYTHON

The command has a Python script executed when the file name is specified or allows to enter a Python shell when the option is not used.

Usage:

UM2114

AT+S.PYTHON

Default value: 0

Possible values:

• 0 → active mode

• 1 → powersave mode

• 2 → stop mode

• 3 → standby mode

1) AT+S.PYTHON<cr>

2) AT+S.PYTHON=<filename><cr>

Parameters:

6.8 AT+S.GCFG

This command lists all the configuration variables together with their current value.

Usage:

1) AT+S.GCFG<cr>

2) AT+S.GCFG=<cfg_var><cr>

Parameters:

to enter the MicroPython REPL shell.

to execute the specified script.

specifies the Python script to be executed. After the execution of the script the command returns to the AT console.

to get the full list of configuration variables

to get the value of the specified variable

UM2114 - Rev 3

<cfg_var>

Result:

AT-S.Var:<var>=<value>

<var>

<value>

configuration variable. Refer to Table 7. Configuration

variables for a complete list of the configurable variables.

Specifies the configuration variable name

Specifies the configuration variable value

page 14/66

Page 15

6.9 AT+S.SCFG

Command to set the value of the named configuration variable. The value is saved in the RAM until the command AT+S.WCFG is used.

Usage:

AT+S.SCFG=<key>,<value><cr>

Parameters:

UM2114

AT+S.SCFG

<key>

<value>

6.10 AT+S.WCFG

Command to save the configuration set to the Flash.

Usage:

AT+S.WCFG<cr>

Parameters:

None

6.11 AT+S.FCFG

Command to restore the factory configuration variables from the Flash. It is mandatory to run a reset (HW or SW) after a factory restore.

Usage:

variable to configure

value to be set

AT+S.FCFG<cr>

Note: HW factory restore of the variables is performed by pulling the pin GPIO0 high at power-up (until the

“+WIND:1:Poweron” indication is printed). In order to use the HW factory reset (GPIO0 enabled) and FWUPDATE at the same time, see Section 6.13 AT+S.FSUPDATE.

Parameters:

None

6.12 AT+S.FSWRITE

The command is used to update the external volume via serial interface.

Note: The HW flow control MUST be enabled in order to use the command via UART.

Usage:

UM2114 - Rev 3

page 15/66

Page 16

AT+S.FSWRITE=<length><cr>{data}

Parameters:

<length> Data length to send (in bytes)

6.13 AT+S.FSUPDATE

To download an updated file system from the named host and path. The downloaded image overwrites the existing one. In this case, the user needs to perform a backup of the current file system.

Usage:

AT+S.FSUPDATE=<mem>,<hostname>,[<path&queryopts>],[<port>],[<TLS>],[<username>], [<passwd>]<cr>

Parameters:

<mem>

<path&queryopts>

<port>

<TLS>

UM2114

AT+S.FSUPDATE

specifies the memory where the file system is saved.

• e → user Flash

• i → application Flash

• x → external memory volume

Target host. DNS resolvable name or IP address.

Default:/fs.img. Document path and optional query arguments.

Default 80 (if TLS=0) or 443 (if TLS>0).

Default: 0. Values range: 0 → unsecured; 1 → autodetect; 2 → TLS

Default: none.

6.14 AT+S.FWUPDATE

This command downloads an updated firmware image located at the named host and path. The downloaded image is temporary stored in the internal Flash. The user should perform a procedure to save the content of the file system that will be overwritten during the process.

Note: FWUPDATE can be invalidated by pulling GPIO0 high during the first reset after the execution of AT

+S.FWUPDATE command. In this case, the external filesystem is erased and the FW update is not performed.

Usage:

Note: The HW factory reset pin (GPIO0) must be tight low during F/W update. The HW factory reset can be used after

“+WIND:17:F/W update complete!”

AT+S.FWUPDATE=e,<hostname>,[<path&queryopts>],[<port>],[<TLS>],[<username>], [<passwd>]<cr>

Parameters:

Target host. DNS resolvable name or IP address.

UM2114 - Rev 3

page 16/66

Page 17

UM2114

AT+S.GPIOC

<path&queryopts>

<port>

<TLS>

6.15 AT+S.GPIOC

Command used to configure the function of the various GPIOs on the module. GPIOs can be configured as inputs or outputs. When used as inputs, they generate an interrupt when the state changes that can be configured on the signal edge.

Usage:

1) AT+S.GPIOC=<number>,out<cr>

2) AT+S.GPIOC=<number>,in,

[<interrupt>]<cr>

Parameters:

Default: /fw.fota. Document path and optional query arguments. If a secure FOTA is required, the extension of the file needs to be “.sfota”.

Default 80 (if TLS=0) or 443 (if TLS>0).

Default: 0. Values range: 0 → unsecured; 1 → autodetect; 2 → TLS

Default: none.

to configure a gpio as an output

to configure a gpio as an input

6.16 AT+S.GPIOR

AT+S.GPIOR is used to read the value and the direction of a previously-configured GPIO.

Usage:

AT+S.GPIOR=<num><cr>

Parameters:

<num>

Result:

GPIO Number (see Datasheet)

Default: No interrupt (turn it off, if enabled). It can assume one of the following values:

• R → Rising edge

• F → Falling edge

• B → Both rising and falling edges

specifies the GPIO to read

UM2114 - Rev 3

AT-S.Value:<num>:<level>:<direction>

page 17/66

Page 18

UM2114

AT+S.GPIOW

<num>

<level>

6.17 AT+S.GPIOW

AT+S.GPIOW is used to set the value of a previously-configured output GPIO.

Usage:

AT+S.GPIOW=<num>,<level><cr>

Parameters:

<num>

<level>

6.18 AT+S.DAC

The DAC command enables DAC on GPIO15.

Usage:

Specifies the number of GPIO read

0 (low) or 1 (high)

0 (output pullup) or 1 (input)

specifies the GPIO to be set

specifies one possible value(0|1) for the specified GPIO.

AT+S.DAC=<value><cr>

Parameters:

<value>

6.19 AT+S.ADC

AT+S.ADC returns ADC value on the selected GPIO. The value range is between 0 and 3300 mV with a measurement accuracy of 10 mV.

Usage:

AT+S.ADC=<num><cr>

Parameters:

<num>

must be set in mV (between 1 and 3300). The value=0 disables DAC on GPIO15

specifies the GPIO to be used for conversion. Available GPIOs are 0, 1 and 16

UM2114 - Rev 3

page 18/66

Page 19

Result:

AT-S.Value:<value>

UM2114

AT+S.PWM

<value>

6.20 AT+S.PWM

The PWM command enables PWM on the selected GPIO, with a specified frequency and duty-cycle.

Usage:

AT+S.PWM=<num>,<frequency>[,<duty_cycle>]<cr>

Parameters:

<num>

<duty_cycle>

6.21 AT+S.TIME

Command to get or set the time (date, time)

Usage:

Specifies the ADC value

specifies the GPIO to be used for PWM. Available GPIOs are 2 and 4

value between 1 and 10 kHz. The value=0 disables PWM

default: 50%. The value is in the 0 - 100 range.

1) AT+S.TIME<cr>

2) AT+S.TIME=<time>

Parameters:

<time>

Result:

AT-S.Date:<yy>.<mo>.<dd>:<day>

AT-S.Time:<hh>.<mi>.<ss>

<yy>

returns the current date in the format “ATS.Date:yy.mm.dd:nn” and the current time in the format “ATS.Time:hh:mm:ss”. The time refers to UTC format and must be expressed as the time in seconds since 1970-Jan-01.

sets the time as specified by the parameter

value to set the time. The time refers to UTC format and it must be expressed in seconds since 1970-Jan-01.

Specifies the year

UM2114 - Rev 3

page 19/66

Page 20

UM2114

AT+S.RANDOM

<mo>

<dd>

<day>

<hh>

<mi>

<ss>

6.22 AT+S.RANDOM

Command that provides a random number generated by the peripheral integrated in the STM32.

Usage:

AT+S.RANDOM<cr>

Parameters:

None

Specifies the month

Specifies the day

Specifies the year of the week

Specifies the hours

Specifies the minutes

Specifies the seconds

Result:

AT-S.Number:<value>

<value>

6.23 AT+S.FSC

This command has effect in the RAM memory volume and external SD card volume. The command creates a file in the selected volume or appends the data following the command in case the file already exists. The space available in the file system in RAM can be set using ramdisk_memsize configuration variable. Minimum size is 2 Kb, resulting in maximum 2 files.

Usage:

AT+S.FSC=<filename>,<datalen><cr>{data}

Parameters:

Specifies the 32-bit random number

name of the file. Max size is 64 bytes

amount of space in bytes to allocate for the file

6.24 AT+S.FSD

The command has effect in the RAM memory volume and external SD card volume. The command deletes an existing file.

UM2114 - Rev 3

page 20/66

Page 21

Usage:

AT+S.FSD=<filename><cr>

Parameters:

UM2114

AT+S.FSR

6.25 AT+S.FSR

The command has effect in the RAM memory volume and external SD card volume. The command renames an existing file.

Usage:

AT+S.FSR=<old_filename>,<new_filename><cr>

Parameters:

<old_filename>

<new_filename>

6.26 AT+S.FSL

This command lists the existing filenames together with their prefix that indicates where they are stored and the size.

name of the file to be deleted

filename to be renamed

new file name

UM2114 - Rev 3

X → External Flash (Volume ID:0)

E → User Flash (stored at STM32F439 address 0x08110000) (Volume ID:1)

D → RAM (Volume ID:2)

I → Application Flash (stored at STM32F439 address 0x08100000)

(Volume ID:3)

Note that Volume ID 3, Application Flash, when protected (app_fs status variable set to 2) does not show content files.

Usage:

1) AT+S.FSL<cr>

2) AT+S.FSL=[<output_filename>]

print the list of the files on the std output

print the list of the files in the specified name

Parameters:

page 21/66

Page 22

UM2114

AT+S.FSP

<output_filename>

Result:

AT-S.File:<flag>\t<len>\t<name>

<flag>

<len>

<name>

6.27 AT+S.FSP

This command prints the content of the specified file starting from the offset and for the specified length.

Usage:

AT+S.FSP=<filename>,[<offset>],[<len>]<cr>

Default:2:/dir.txt. When this option is specified, the output of the command is saved in the named filename

X (External Flash) or E (User Flash) or D (RAM) or I (Application Flash)

Specifies the file length

Specifies the file name

Note that Volume ID 1, Application Flash, when protected (app_fs status variable set to 2) does not allow print on selected file.

Parameters:

<len>

6.28 AT+S.FSM

The command is used to mount the selected volume.

Usage:

AT+S.FSM=[<volume>]<cr>

Parameters:

<volume> Default:0; Indicates the memory volume

6.29

AT+S.FSU

The command is used to umount/erase the user memory volumes.

Usage:

name of the file to be printed

Default Value:0; indicates the byte from where the file is printed

Default Value: Filesize-Offset; indicates the number of bytes that are printed

UM2114 - Rev 3

AT+S.FSU=[<volume>],[<erase>]<cr>

Parameters:

page 22/66

Page 23

UM2114

AT+S.HASH

<erase>

6.30 AT+S.HASH

The command is used to compute a message digest of a given file.

Usage:

AT+S.HASH=[<function>],<filename><cr>

Parameters:

Result:

Default:0; Indicates the memory volume.

Default:0; when”1”, the specified volume is fully erased

Default:0; Indicates the selected hash function. Possible values are 0: SHA1; 1: SHA224; 2: SHA256; 3: MD5

filename to be used

AT-S.SHA1:<digest> or

AT-S.SHA224:<digest> or

AT-S.SHA256:<digest> or

AT-S.MD5:<digest>

6.31 AT+S.WPAECERT

To manage WPA certificates in the module Flash memory.

Usage:

AT+S.WPAECERT=content,<option><cr>

AT+S.WPAECERT=<kind>,<size><cr>{data}

Parameters:

Specifies the digest of given file

to list or to remove certificates within the Flash

to load certificates/key within the module memory

When the value is equal to 1, the command lists the certificates and key stored in the Flash memory. When the value is equal to 2 the command removes certificates and keys stored in the Flash.

UM2114 - Rev 3

page 23/66

Page 24

<kind>

<size>

6.32 AT+S.TLSCERT

To Manage TLS certificates in the Module Memory. Note that if Flash is empty, the TLS layer will look for files in the filesystem with the default names of “tls.cert” and “tls.key” for client certificate and key, while CA certificates need filenames corresponding to their Subject Key Identifier (e.g.: "C07A98688D89FBAB05640C117DAA7D65B8CACC4E.ca"). Note also that depending on the type of certificate format loaded (DER or PEM), the subject key identifier is automatically found by the module itself. The “auth” parameter is only required when loading PEM format.

Usage:

AT+S.TLSCERT=content,<option><cr>

AT+S.TLSCERT=<kind>,<size><cr>{data}

UM2114

AT+S.TLSCERT

Possible values are as follows:

• Ca → {data} correspond to the RADIUS CA

• Cert → {data} correspond to the SPWF04S certificate

• Key → {data} correspond to the SPWF04S key

Data size in bytes. Data can be transferred in PEM (textual) or in DER (binary) format.

Parameters:

<kind>

<size>

6.33 AT+S.WPS

Initiate a WPS exchange.

Usage:

AT+S.WPS=<mode><cr>

When the value is equal to 1, the command lists the certificates and key stored in the Flash memory. When the value is equal to 2, the command removes the certificates and keys stored in the Flash.

Possible values are as follows:

• Ca → {data} correspond to the Peer CA

• Cert → {data} correspond to the SPWF04S certificate

• Key → {data} correspond to the SPWF04S key

• Auth → {data} peer’s CA Authority Key ID

Data can be transferred in PEM (textual) or in DER (binary) format.

UM2114 - Rev 3

Parameters:

page 24/66

Page 25

<mode>

Result:

AT-S.Generated user PIN:<pin> or

AT-S.Generated random PIN:<pin>

UM2114

AT+S.WIFI

mode=0: emulates the push button as defined by the WPS standard

mode=1: executes WPS PIN mode using the factory PIN of the device (stored in the configuration variable wifi_wps_pin)

mode=2: executes WPS PIN mode using a random generated PIN

<pin>

6.34 AT+S.WIFI

AT+S.WIFI allows the radio to be enabled or disabled at run-time. Please note that the configuration variable "wifi_mode" controls the state of the radio at power-up.

Usage:

AT+S.WIFI=<action><cr>

Parameters:

6.35 AT+S.SCAN

AT+S.SCAN performs an immediate scan for available networks. The output reports the BSSID, SSID, the network channel, signal strength (RSSI), AP capabilities and 802.11 options included security.

Specifies the 8-digit pin used for WPS exchange

can assume the values: 0: radio is off, 1: radio is on

Figure 6. AP capabilities list

UM2114 - Rev 3

Usage:

AT+S.SCAN=<filter>,[<filename>]<cr>

page 25/66

Page 26

Parameters:

UM2114

AT+S.SSIDTXT

6.36 AT+S.SSIDTXT

AT+S.SSIDTXT allows to get/set the current value of the variables wifi_ssid and wifi_ssid_len as text strings

Usage:

AT+S.SSIDTXT<cr>

AT+S.SSIDTXT=<ssidtxt><cr>

Parameters:

Result:

Range of possible values is: d → no filter, s → filter on ssid, m → filter on the mac

Default:std output. When specified, the output of the command is saved in the <filename> file.

get the value of the variable wifi_ssid.

set the value of the variables wifi_ssid and wifi_ssid_len

SSID in textual format

AT-S.Network:<SSID>

<SSID>

6.37 AT+S.PING

Send a single ICMP ECHO request to a specified remote host. When IPv6 is enabled, every network request for name resolution will use IPv6 at the beginning. This means that WIND:24:IPv6 must be waited when ip_use_v6.

Usage:

AT+S.PING=[<counter>],[<size>],<hostname><cr>

Parameters:

<size>

Specifies the SSID of current configured network

Default value:1. Number of echo requests to send

Default value:56 bytes. Highest size of the echo packet. Every sent, or incoming, request will be truncated

Remote Host. DNS resolvable name or IP address

UM2114 - Rev 3

page 26/66

Page 27

6.38 AT+S.SOCKON

To open a socket client. Up to 8 socket clients can be set simultaneously on the device. The command returns the identifier to be used for operations on the socket.

Usage:

AT+S.SOCKON=<hostname>,<port>,<NULL>,<kind><cr>

Parameters:

UM2114

AT+S.SOCKON

<port>

<kind>

Result:

AT-S.On:<IP>:<id>

<IP>

<id>

6.39 AT+S.SOCKQ

To query a socket client for pending data. The command returns the number of bytes that are waiting on the socket.

Usage:

Remote Server. DNS resolvable name or IP address

TCP/UDP socket port

This parameter can assume the values:

• t → tcp

• u → udp

• s → TLS socket using <Hostname> as domain name.

• TLS Server Domain Name → Common name of the server (URL or the CN field reported into server certificate) for TLS socket

Specifies the server IP address

Specifies the socket client identifier

UM2114 - Rev 3

AT+S.SOCKQ=<id><cr>

Parameters:

<id>

Result:

Socket Client ID

page 27/66

Page 28

AT-S.Query:<len>

UM2114

AT+S.SOCKC

<len>

6.40 AT+S.SOCKC

To close a socket client.

Usage:

AT+S.SOCKC=<id><cr>

Parameters:

<id>

Note: When a socket client receives an indication about socket server gone (only for TCP/TLS sockets, WIND:58), the socket resource is not automatically cleared. Moreover, flushing pending data (using the AT +S.SOCKR command) is mandatory before closing the socket connection (AT+S.SOCKC). If the buffer is not empty, the “ERROR:Pending data” is raised.

6.41 AT+S.SOCKW

To write data to a socket client. The host is expected to send <length> characters of data after the end of the command.

Usage:

Specifies the number of bytes in socket client buffer

Socket Client ID

AT+S.SOCKW=<id>,<length><cr>{data}

Parameters:

<id>

6.42 AT+S.SOCKR

To read data from a socket client.

Usage:

AT+S.SOCKR=<id>,[<length>]<cr>

Parameters:

Socket Client ID

Data length to send (in bytes)

UM2114 - Rev 3

page 28/66

Page 29

UM2114

AT+S.SOCKL

<id>

6.43 AT+S.SOCKL

To list opened socket clients.

Usage:

AT+S.SOCKL<cr>

Parameters:

None

Result:

AT-S.List::<id>:<connected>:<kind>:<len>:<IP>:<port>

Socket Client ID

Defaut:0. Length (in bytes) of the buffer to read. The value 0 indicates to read the full buffer

<id>

<kind>

<len>

<IP>

<port>

6.44 AT+S.SOCKDON

To open a socket server. The device can manage up to 2 socket servers each supporting 8 socket clients. The command returns the server socket ID to be used in the related commands.

Usage:

AT+S.SOCKDON=<port>,<kind><cr>

Parameters:

<port>

<kind>

Specifies the socket client identifier

Specifies whether socket client is connected to socket server

Specifies the kind of socket client

Specifies the number of bytes in socket client buffer

Specifies the server IP address

Specifies the client port

socket port

specifies the kind of socket as one of the following:

• t → tcp

• u → udp

• s1 → TLS socket with one-way authentication

• s2 → TLS socket with mutual authentication

UM2114 - Rev 3

page 29/66

Page 30

Result:

AT-S.On:<id>

UM2114

AT+S.SOCKDQ

<id>

6.45 AT+S.SOCKDQ

To query a socket server for pending data.

Usage:

AT+S.SOCKDQ=<sid>,<cid><cr>

Parameters:

<sid>

<cid>

Result:

AT-S.Query:<len>

Specifies the socket server identifier

socket server identifier

socket client identifier

<len>

6.46 AT+S.SOCKDC

To close a socket server or to disconnect a client.

Usage:

AT+S.SOCKDC=<sid>

AT+S.SOCKDC=<sid>[,<cid>]

Parameters:

<sid>

<cid>

Note: Flushing pending data (using the AT+S.SOCKDR command) is mandatory before closing the socket connection (AT+S.SOCKDC). If the buffer is not empty, the “ERROR: Pending data” is raised.

Specifies the number of bytes in client buffer

to close the specified socket server (and disconnect all clients)

to disconnect the specified client, if client_id is given. If not, all clients are disconnected, and server is closed

socket server identifier

socket client identifier

UM2114 - Rev 3

page 30/66

Page 31

6.47 AT+S.SOCKDW

To write data to a socket server.

Usage:

AT+S.SOCKDW=<sid>,<cid>,<len><cr>{data}

Parameters:

UM2114

AT+S.SOCKDW

<sid>

<cid>

<len>

6.48 AT+S.SOCKDR

To read data from a socket server.

Usage:

AT+S.SOCKDR=<sid>,<cid>,[<len>]<cr>

Parameters:

<sid>

<cid>

<len>

6.49 AT+S.SOCKDL

To list the bound socket client.

Usage:

socket server identifier

socket client identifier

length (in bytes) of the buffer to write that is sent after the command.

socket server identifier

socket client identifier

Default:0. length (in bytes) of the buffer to read. The value=0 indicates to read the entire buffer.

UM2114 - Rev 3

AT+S.SOCKDL

AT+S.SOCKDL=<sid><cr>

Parameters:

<sid>

to list bound clients on all servers

socket server identifier

page 31/66

Page 32

Result:

AT-S.List:<id>:<cid>:<connected>:<kind>:<len>:<IP>:<port>

UM2114

AT+S.TFTPGET

<id>

<cid>

<kind>

<len>

<IP>

<port>

6.50 AT+S.TFTPGET

The stack implements the TFTP client protocol to transfer files on a UDP port. The command performs a request to a specified TFTP server.

Usage:

AT+S.TFTPGET=<hostname>,[<port>],<filename>,<local_filename><cr>

Parameters:

<port>

<local_filename>

Specifies the socket server identifier

Specifies the socket client identifier

Specifies whether socket client is connected to socket server

Specifies the kind of socket client

Specifies the number of bytes in client buffer

Specifies the client IP address

Specifies the client port

DNS resolvable name or IP address of the TFTP remote server

Default:69. Socket UDP port

filename to get from the remote host. It contains the complete path

Default:2:<Filename>. Filename used locally

6.51 AT+S.TFTPPUT

The stack implements the TFTP client protocol to transfer files on a UDP port. The command performs a request to a specified TFTP server.

Usage:

AT+S.TFTPPUT=<hostname>,[<port>],<local_filename><cr>

Parameters:

<port>

<local_Filename>

UM2114 - Rev 3

DNS resolvable name or IP address of the TFTP remote server

Default: 69. Socket UDP port

filename to send to the remote host

page 32/66

Page 33

6.52 AT+S.SMTP

The stack implements the protocol SMTP to send an email.

Usage:

AT+S.SMTP=<hostname>,[<port>],[<TLS>],[<username>],[<passwd>], [<ID>],<address>,<to>,<NULL>,<NULL>,<subject>,<NULL>,<len><cr>{data}

Parameters:

UM2114

AT+S.SMTP

<port>

<TLS>

<ID>

<to>

<len>

6.53 AT+S.HTTPGET

To perform a single http get request to the named host and path.

Usage:

DNS resolvable Name or IP address of the remote host

Default is 25 (if TLS=0) or 465 (if TLS>0). Server port

Default:unsecured TLS Security option. 0 → unsecured, 5 → SMTPS on port 465 if available, otherwise SMTP + STARTTLS if available, otherwise no security, 8 → SMTP + STARTTLS if available, otherwise the mail is not sent, 9 → SMTPS on port 465 if available, otherwise SMTP + STARTTLS if available, otherwise the mail is not sent.

User of the SMTP server

Password of the SMTP server

Default: nv_model used during Helo

Email address on the SMTP server

Email recipients. Multiple emails are separated by a semicolon

A recipient can be just an email address, or be in the extended format consisting of a name followed by a '<', followed by the email address and terminated by a '>' (e.g. "Nick <nick@name.xy>")

Email Subject. String message

Length of the Body message

UM2114 - Rev 3

AT+S.HTTPGET=<hostname>,[<path&queryopts]>,[<port>],[<TLS>],[<username>], [<passwd>],[<in_filename>],[<out_filename>]<cr>

Parameters:

<path&queryopts>

<port>

DNS resolvable Name or IP address

Default:/index.html. document path & optional query arguments

Default 80 (if TLS=0) or 443 (if TLS>0)

page 33/66

Page 34

UM2114

AT+S.HTTPPOST

<TLS>

<in_filename>

<out_filename>

6.54 AT+S.HTTPPOST

To perform a post of the specified file to a remote host.

Usage:

AT+S.HTTPPOST=<hostname>,[<path&queryopts]>,[<port>],[<TLS>],[<username>], [<passwd>],[<in_filename>],[<out_filename>]<cr>

Parameters:

<path&queryopts>

<port>

<TLS>

<in_filename>

<out_filename>

Default: 0. Values range: 0 → unsecured; 1 → autodetect; 2 → TLS

Default: none

Default: none. Custom http requests

Default: Console. When specified the return data are saved in a file

DNS resolvable Name or IP address

Default:/index.html. document path & optional query arguments

Default 80 (if TLS=0) or 443 (if TLS>0)

Default: 0. Values range: 0 → unsecured; 1 → autodetect; 2 → TLS

Default: none

Default: none. Console. When specified the return data are saved in a file

Default: none. Filename to transfer to the server. Please refer to following table the right association between file extension and HTTP Content-Type.

UM2114 - Rev 3

Table 5. Association between file extension and HTTP content-type

File extension

html text/html

fhtml text/html

css text/css

txt text/plain

xml text/xml

xls text/xls

gif image/gif

jpg image/jpg

bmp image/bmp

Content-type

page 34/66

Page 35

png image/png

ico image/x-icon

class application/x-java-applet

swf application/x-shockwave-flash

json application/json

woff application/font-woff

form application/x-www-form-urlencoded

unknown extension application/x-raw-stuff

6.55 AT+S.INPUTSSI

Fill buffer for raw text input SSI . See AN4965 for details on the use of the SSI.

Usage:

AT+S.INPUTSSI=<length><cr>{data}

UM2114

AT+S.INPUTSSI

File extension Content-type

Parameters:

Note: {data} used to fill the buffer must be properly set. The first byte is used as a token splitter; so use this special character to fill the buffer with multiple tokens. Every token can be directly referred remotely by SSI indexes contained inside the HTML page. For example: “|hello|world|” will create 2 tokens: "hello” accessed by , and “world” accessed by .

6.56 AT+S.MQTTCONN

To open a connection with an MQTT Broker. The command returns a local ID =0, used in the correspondent commands. The device manages one MQTT connection at a time.

Usage:

AT+S.MQTTCONN=<hostname>,[<port>],[<path>],[<TLS>],[<username>],[<passwd>], [<userID>],[<keep_alive>],[<retry>],[<lastWill_QoS>],[<lastWill_topic>], [<lastWill_message>]<cr>

Length of the data to save in the buffer. The length=0 cleans the buffer.

UM2114 - Rev 3

Parameters:

<port>

<path>

DNS resolvable name or IP address of the MQTT broker

Default:1883

Default:/

page 35/66

Page 36

UM2114

AT+S.MQTTPUB

<TLS>

<keep_alive>

<retry>

<lastWill_QoS>

<lastWill_topic>

<lastWill_message>

Result:

AT-S.On:<id>:<session>

<id>

Default: 0. Values range: 0 → unsecured; 1 → autodetect; 2 → TLS

Default: none. User Name

Default: none. Passwd

Default: nv_model used during MQTT communications

Default: 60 seconds

Default: 15 seconds

Default: 0. Last action to be executed by the broker when the node disappears without a disconnect procedure

Default: None. Last Will Topic

Default: None. Published on the Last Will Topic

Specifies the MQTT client identifier

0 (new session) or 1 (session restored)

6.57 AT+S.MQTTPUB

To publish a message to an MQTT broker

Usage:

AT+S.MQTTPUB=0,<topic>,[<QoS>],[<retained_flag>],<len><cr>{data}

Parameters:

<topic>

<QoS>

<retained_flag>

<len>

6.58 AT+S.MQTTDISC

To disconnect from an MQTT broker.

Usage:

Topic where the message is published

Default: 0. Values Range: 0 → at most once delivery; 1 → at least one delivery; 2 → exactly one delivery

Default: 0. Possible values: 0 → do not retain, 1 → retain

MQTT message length

UM2114 - Rev 3

AT+S.MQTTDISC=0<cr>

Parameters:

page 36/66

Page 37

None

6.59 AT+S.MQTTSUB

To subscribe topic to an MQTT broker.

Usage:

AT+S.MQTTSUB=0,<topic>,[<QoS>]<cr>

Parameters:

UM2114

AT+S.MQTTSUB

<topic>

<QoS>

6.60 AT+S.MQTTUNSUB

To unsubscribe topic from an MQTT broker.

Usage:

AT+S.MQTTUNSUB=0,<topic><cr>

Parameters:

<topic>

6.61 AT+S.WSOCKON

The module supports the usage of two web socket clients. The command returns the ID that is used in the corresponding commands.

The MQTT layer is built on top of web sockets. This means that (when an MQTT broker has been connected through AT+S.MQTTCONN) the total amount of available web sockets decreases to just 1. Note that it is not possible to run another AT+S.WSOCKON to the same web socket server.

Usage:

Topic where the node subscribes

Default:0. Values Range: 0 → at most once delivery; 1 → at least one delivery; 2 → exactly one delivery

Topic where the node unsubscribes

UM2114 - Rev 3

AT+S.WSOCKON=<hostname>,[<port>],[<path>],[<TLS>],[<username>],[<passwd>], [<origin>],[<protocols>],[<extensions>]<cr>

Parameters:

<port>

DNS resolvable name or IP address of the web socket server

Default 80 (if TLS=0) or 443 (if TLS>0)

page 37/66

Page 38

UM2114

AT+S.WSOCKQ

<path>

<TLS>

Result:

AT-S.On:<id>

<id>

6.62 AT+S.WSOCKQ

To query web socket client for pending data.

Usage:

Default:/

Default: 0. Values range: 0 → unsecured; 1 → autodetect; 2 → TLS

Default: none. Username on the remote server

Default: none. Password on the remote server

Default:none. Header Field Origin

Default:none. Header Field Protocols

Default:none. Header Field Extensions

Specifies the Web Socket client identifier

AT+S.WSOCKQ=<id><cr>

Parameters:

<id>

Result:

AT-S.Query:<len>

<len>

6.63 AT+S.WSOCKC

To close a web socket client using a specific status code.

Usage:

AT+S.WSOCKC=<id>,[<status>]<cr>

Web socket client identifier

Specifies the number of bytes in Web Socket client buffer

UM2114 - Rev 3

Parameters:

page 38/66

Page 39

UM2114

AT+S.WSOCKW

<id>

Note: When a web socket client receives an indication about web socket server gone (WIND:89), the web socket resource is not automatically cleared. Moreover, flushing pending data (using the AT+S.WSOCKR command) is mandatory before closing the socket connection (AT+S.WSOCKC). If the buffer is not empty, the “ERROR:Pending data” is raised.

6.64 AT+S.WSOCKW

To write data to a web socket.

Usage:

AT+S.WSOCKW=<id>,[<last_frame>],[<last_frag>],[<binary>],<len><cr>{data}

Parameters:

<id>

<last_frame>

<last_frag>

Web socket client identifier

Default:0; 0 → Normal Closure; 1 → Going Away; For a complete list of the status values defined for the web socket, refer to the related standard

Web socket client identifier

Default:0. 1 → Last frame flag

Default:0. 1 → Last frag flag

Default:0, textual. 1 → Binary flag

6.65 AT+S.WSOCKR

To read data from a web socket client.

Usage:

AT+S.WSOCKR=<id>,[<len>]<cr>

Parameters:

<id>

<len>

6.66 AT+S.WSOCKL

To list opened web socket clients.

Usage:

AT+S.WSOCKL<cr>

Web socket client identifier

Default 0. 0 value indicates read the full buffer

UM2114 - Rev 3

page 39/66

Page 40

Parameters:

None

Result:

AT-S.List:<id>:<connected>:<len>>:<port>

UM2114

AT+S.WSOCKL

<id>

<len>

<port>

Specifies the Web Socket client identifier

Specifies wheter Web Socket client is connected to Web socket server

Specifies the number of bytes in Web Socket client buffer

Specifies the local port

UM2114 - Rev 3

page 40/66

Page 41

7 Technology partners

Partner Device description Part number

MACRONIX 8-Mbit CMOS Serial Flash memory MX25L8006E

MACRONIX 64-Mbit CMOS Serial Flash memory MX25L6433F

UM2114

Technology partners

Table 6. Technology partners

UM2114 - Rev 3

page 41/66

Page 42

UM2114

Variables and values

8 Variables and values

The following table lists the configuration variables together with their default values. The list of configuration variables is generated by the command AT+S.GCFG.

Table 7. Configuration variables

Variable name Default value Type Description

nv_manuf

nv_model SPWF04SA TEXT[32] Manufacturer Model String

nv_serial 0517<11222 TEXT[32] Manufacturer Serial Number

nv_wifi_macaddr 00:80:E1:FA:12:34 HEX[6] Manufacturer assigned 802.11 MAC Address

standby_time 10 INT

standby_enabled 0 INT Enable/disable the standby mode

sleep_enabled 0 INT Enable/Disable the sleep mode

etf_mode 0 INT

blink_led 1 INT Manage led drive GPIO(10). 0-off 1-0n

ext_volume 3 INT

ramdisk_memsize 16 INT

aes128_key

user_desc anonymous TEXT[16] Password used during remote configuration

python_script 3:/uPython_test.py TEXT[64]

python_memsize 32 INT

console_enabled 1 INT

console_speed 115200 INT Serial Port Speed: from 9600 to 921600.

console_hwfc 0 INT Hardware Flow Control. 0=off; 1=on

console_echo 1 INT Echo command input. 0=off, 1=on

console_errs 2 INT

console_winds 2 INT

console_verbose 1 INT

console_repeater 0x21 HEX Set the console repeater.

console_delimiter 0x2C HEX Set the console delimiter.

STMicroelectronics Inc.

00:00:00:00:00:00:00: 00:00:00:00:00:00:00: 00:00

TEXT[32] Manufacturer ID string

Standby mode time, in seconds. Up to 2exp(32)-1 sec

Enable/Disable the Engineering test functions. It is used to control the radio for the certification tests

Used to manage ext. storage. 0-disabled, 1SDCARD, 2-SPI, 3-Autodetection

Heap size dedicated to RAM disk in unit of 1024 byte

HEX[16] AES-128 key used to encrypt FOTA image

Specifies the python script to run when GPIO[8] is high at the boot time

Heap size dedicated to MicroPython execution in unit of 1024 byte

0→SPI; 1→ UART; 2→UART+Python; 3→Python

ERROR:#:string Format.

Format Selection. 0→ simple notification 1:→ numbered notification 2→ verbose notification

WIND:#:string:p

Format Selection. 0→ simple notification 1:→ numbered notification 2→ verbose notification

Verbose output. 0=off; 1=on, with short OK message; 2=full on

UM2114 - Rev 3

page 42/66

Page 43

Variable name Default value Type Description

Wind 0:31 mask

console_wind_off_low 0x00000000 HEX

console_wind_off_medium 0x00000000 HEX Wind 32:63 mask

console_wind_off_high 0x00000000 HEX Wind 64:95 mask

wifi_tx_msdu_lifetime 0 INT

wifi_rx_msdu_lifetime 0 INT

wifi_operational_mode 0x00000011 INT

wifi_beacon_wakeup 1 INT(sec)

wifi_beacon_interval 100 INT

wifi_listen_interval 0 INT

wifi_rts_threshold 3000 INT

53:54:54:65:73:74:00:

wifi_ssid

wifi_ssid_len 6 INT

wifi_txfail_thresh 5 INT

wifi_dtim_period 1 INT

wifi_add_tim_ie 0 INT

wifi_region 1 INT

00:00:00:00:00:00:00: 00:00:00:00:00:00:00: 00:00:00:00:00:00:00: 00:00:00:00

HEX[32]

0xFFFFFFFF are disabled

all the 32 Wind indicator

MSDU lifetime. From 0 to 2^32-1 TUs (1 TUs=

1024μs). Zero is default (automatic)

MSDU lifetime. From 0 to 2^32-1 TUs (1 TUs=

1024μs). Zero is default (automatic)

Allows choosing Doze (11) or quiescent (12) power device modes

Set the wakeup interval of the WLAN device, from 1 to 255 if wifi_listen_interval = 0; from 1 to 65535 if wifi_listen_interval = 1

Beaconing interval in MiniAP mode, from 0 to

2^16-1

Define the wakeup mode (0 = sleep up to the beacon_wakeup specified, 1 = sleep at least to the beacon_wakeup specified)

Frame size over which RTS/CTS is used. Limit:

from 0 to 3000

Can be get/set with the command AT +S.SSIDTXT. Desired SSID specified in hex. All 32 octets should be written. Note that wifi_ssid_len must also be set.

Can be set with the command AT +S.SSIDTXT.

Length of the actual SSID

in the 32 byte buffer

Maximum number of lost packets before disassociation

Amount of frames stored for associated powersaving STAs. 0=do not store frames, 1=store 1 frame

Whether or not to add the TIM information element in miniAP beacons. 0=do not add, 1=add

Setting the scan process used during the command AT+S.SCAN. set the channels allowed for active scan (0 = always passive scan, 1 = active scan only on channels enabled by wifi_chan_activity2 status variable [default], 2 = USA X10 [1-11], 3 = Canada X20 [1-11], 4 = Europe ETSI X30 [1-13], 5 = France X32 [10,11], 6 = Japan X40 [1-13], 7 = Japan X41 [10,11,14]

UM2114

Variables and values

UM2114 - Rev 3

page 43/66

Page 44

UM2114

Variables and values

Variable name Default value Type Description

Enable the 802.11n mode. The 11n data rates

wifi_ht_mode 1 INT

wifi_channelnum 1 INT

wifi_opr_rate_mask 0x003FFFCF INT

wifi_bas_rate_mask 0x0000000F INT

wifi_mode 1 INT

wifi_auth_type 0 INT

wifi_atim_window 0 INT Reserved

wifi_powersave 0 INT

wifi_tx_power 18 INT Transmit power [from 0 to 18], in dBm

must be enabled with the wifi_opr_rate_mask

variable (i.e. wifi_opr_rate_mask=3FFF CF to enable all the data rate supported)

Channel number to use for MiniAP operation. The user must properly set the channel number to not violate IEEE 802.11 Wi- Fi/ WLAN standards.

BIT0: 1 Mbps

BIT1: 2 Mbps

BIT2: 5.5 Mbps

BIT3: 11 Mbps

BIT6: 6 Mbps

BIT7: 9 Mbps

BIT8: 12 Mbps

BIT9: 18 Mbps

BIT10: 24 Mbps

BIT11: 36 Mbps

BIT12: 48 Mbps

BIT13: 54 Mbps

BIT14: MCS0 (6.5Mbps)

BIT15: MCS1 (13Mbps)

BIT16: MCS2 (19.5Mbps)

BIT17: MCS3 (26Mbps)

BIT18: MCS4 (39Mbps)

BIT19: MCS5 (52Mbps)

BIT20: MCS6 (58.5Mbps)

BIT21: MCS7 (65Mbps)

Basic data rate mask, 0x0000000f is [1,2,5.5,11]

Radio mode.

0=IDLE

1=STA (Supported Security Modes: OPEN, WEP OpenSystem, WEP SharedKey, WPA/ WPA2 - wifi_auth_type must be set to 0, WPA-Enterprise)

2=IBSS (Supported Security Modes: OPEN, WEP OpenSystem, WEP SharedKey)

3=MiniAP (Supported Security Modes: OPEN, WEP OpenSystem, WPA/WPA2 wifi_auth_type must be set to 0, Supported Classes: b,g) *

Authentication type used in STA, IBSS and MiniAP mode: 0=OpenSystem, 1=SharedKey

Allows choosing between Active (0), PS (1) or Fast-PS (2)

UM2114 - Rev 3

page 44/66

Page 45

Variables and values

Variable name Default value Type Description

wifi_rssi_thresh 0 INT Low signal strength threshold

wifi_rssi_hyst 0 INT

wifi_ap_idle_timeout 120 INT

wifi_beacon_loss_thresh 10 INT

wifi_priv_mode 0 INT

wifi_wep_keys[0]

wifi_wep_keys[1]

wifi_wep_keys[2]

wifi_wep_keys[3]

wifi_wep_key_lens 00:00:00:00 HEX[4]

wifi_wep_default_key 0 INT WEP key index

wifi_wpa_psk_raw

wifi_wpa_psk_text TEXT[64]

wifi_eap_identity identity TEXT[32]

wifi_eap_anon_identity

wifi_eap_passwd password TEXT[32]

wifi_eap_type 0 INT

wifi_eap_skip_datechecks 0 INT

wifi_wps_walk_time 120 INT Button push time window length

00:00:00:00:00:00:00: 00:00:00:00:00:00:00: 00:00

00:00:00:00:00:

00:00

anonymous@identity. org

HEX[16] WEP key buffer

HEX[32] Pre-calculated PSK key

TEXT[32]

Amount of change in RSSI to trigger signal state change

Seconds of inactivity to trigger disassociate of the client

Number of consecutive loss beacon to detect the AP disassociation (0=network lost not notified, from 1 to 200)

Privacy Mode: 0=none, 1=WEP, 2=WPAPersonal (TKIP/AES) or WPA2- Personal (TKIP/AES) - wifi_auth_type must be set to 0,3=WPA2-Enterprise

Four octets specifying the length of the actual key data in each WEP key buffer

WPA(2) PSK passphrase, if set the actual PSK will be generated from this. Used in STA, IBSS and MiniAP.

specifies the username by which the SPWF04S authenticates itself to the network

specifies the anonymous identity string used in the first phase of most of the EAP authentication methods

specifies the password by which the SPWF04S authenticates itself to the network.

EAP authentication method. 0=EAP-TLS; 1=TTLS-MD5, 2=TTLS-MSCHAPv2, 3=PEAP-MD5,4=PEAP-MSCHAPv2

RADIUS certificate date validity check.

0→enabled; 1→disabled

UM2114

UM2114 - Rev 3

page 45/66

Page 46

UM2114

Variables and values

Variable name Default value Type Description

wifi_wps_pin 1234567 INT Wps pin

ip_sock_memsize 1 INT

ip_sock_threshold 0 INT

ip_dhcp_lease_time 120 INT

ip_macfilter 00:00:00:00:00:00 HEX[6]

ip_num_clients 5 INT

ip_allow_port_scans 1 INT

ip_use_v6 1 INT IPv6 Enable.

ip_use_dhcpd 1 INT

ip_use_httpd 1 INT HTTP Enable. 0=off;1=on

ip_use_tftpd 1 INT TFTP Enable. 0=off;1=on

ip_use_dhcpc 2 INT Dhcp Client. 0→off; 1→on; 2→ autoip

ip_hostname iwm-FA-12-34 TEXT[32] IP local hostname

ip_apdomainname captiveportal.net TEXT[32]

ip_apredirect firstset.html TEXT[16]

ip_ipaddr 192.168.0.50 IP IP address for static usage (DHCP off)

ip_netmask 255.255.255.0 IP IP netmask for static usage (DHCP off)

ip_gw 192.168.0.1 IP IP default gateway for static usage (DHCP off)

ip_dns1 208.67.222.222 IP

ip_dns2 208.67.220.220 IP

ip_local 0:0:0:0:0:0:0:0 IPv6 IPv6 unique local address

ip_dns1v6 0:0:0:0:0:0:0:0 IPv6

ip_dns2v6 0:0:0:0:0:0:0:0 IPv6

ip_dhcp_timeout 20 INT

ip_ntp_server1 ptbtime1.ptb.de TEXT[32] Primary NTP server (IPv4)

ip_ntp_server2 ntp0.ipv6.fau.de TEXT[32]

Heap size dedicated to every socket connection in unit of 1500 byte

Percentage of ip_sock_memsize used to allow +WIND:55 and +WIND:88 indications

IP address renew of the

peers in MiniAP mode

(default: 120 sec)

Mask for filtering of mac address during the association process. The IP is not released to not selected mac address

Number of allowed clients. IP not released beyond this number

Scan from remote port enabler. 0=do not allow; 1=allow

DHCP Server Enable. To be Used in MiniAP mode. 0=off;1=on

Domain name in Mini AP mode. If the AP domain name is not quickly opened, it’s suggested to turn off an eventual proxy server (check the connection settings of the device or the browser preferences). Please be sure to provide a standard extension (.net, .com, etc.)

Default homepage opening the ip_apdomainname in miniAP

IP Primary DNS server for static usage (DHCP off)

IP Secondary DNS server for static usage (DHCP off)

IPv6 Primary DNS server for static usage (DHCP off)

IPv6 Secondary DNS server for static usage (DHCP off)

DHCP client timeout, in

seconds

Secondary NTP server (IPv4 when ip_use_v6=0, IPv6 when ip_use_v6=1)

UM2114 - Rev 3

page 46/66

Page 47

UM2114

Variables and values

Variable name Default value Type Description

ip_ntp_refresh 3600 INT Refresh time interval

ip_ntp_startup 1 INT NTP enabler at the startup. 0→off; 1→on

ip_mdns_domain_name SPWF04S-Default TEXT[32] MDNS domain name

ip_mdns_device_name_ttl 120 INT MDN Time To Live

ip_mdns_services_name

ip_mdns_services_prot _http._tcp _tftp._udp TEXT[64] Services protocol list separated by space

ip_mdns_services_keys dev1 dev2 TEXT[32] Services keys list separated by space

ip_mdns_services_vals number1 number2 TEXT[32] Services values list separated by space

ip_mdns_services_port 80 69 INT Services ports list separated by space

ip_mdns_services_ttl 120 60 INT Services ttl list separated by space

ip_mdns_startup 01:01 HEX[2]

SPWF04S-WebSrv SPWF04S-TFTPSrv

TEXT[64]

The following table lists the status variables together with their associated values. The list of status variables is generated by the command AT+S.STS.

Services list separated by space (max two services)

Services enabler at the startup separated by space

Table 8. Status variables

Status variable Value Note

build 170216-fd39c59-SPWF04S SW Build Version

fw_version 1.0.0 SW Major Version

boot_version 1.0 Boot Version

var_version 1 Variable List version

free_heap 55200 Current free heap space

min_heap 52576 Minimum free heap space thus far

system_time 1467386876 Current Time in UTC format in sec

system_uptime 1780 System Running Time in sec

system_sleeptime 0 System Sleeping time in seconds

H/W reported reason for last reset

0 = POWER_ON

reset_reason 2

startup 0 Failure reasons at the boot time (see wind:7 description)

random_number 3725839442 Random Number generated by the random generator with the AT+S.RANDOM command

gpio_enable 0x0000 Interrupt-enabled GPIO bitmask, expressed in HEX

app_fs 1

user_fs 0 User Flash. 0→ FS not mounted; 1→ mounted

extvol_fs 0 Ext. Storage. 0 → FS not mounted; 1 → mounted

nv_power_cycles 5 Number of executed power-on

1 = WATCHDOG

2 = SOFT RESET

3 = LOW POWER

4 = HW RESET

App Flash. 0 → FS not mounted; 1→ mounted; 2 → mounted and protected. Application Filesystem can be protected through “__LOCKED__” file insert.

UM2114 - Rev 3

page 47/66

Page 48

Status variable Value Note

nv_wdog_resets 0 Number of reset due to watchdog

nv_reset_cycles 43 Number of reset cycles

0= Hardware power up

1=Hardware failure

2=Radio task terminated by user

3=Radio idle

4=Scan in progress

wifi_state 10

wifi_own_macaddr 00:80:E1:FA:12:34 Mac address

wifi_bssid 00:18:F8:3C:D9:18 BSSID of current association

wifi_aid 0 Association ID of current association

wifi_channelnum 11 Current radio channel number

wifi_sup_rate_mask 0x003FFFCF Radio: supported data rate mask

wifi_bas_rate_mask 0x0000000F AP reported: basic data rate mask

wifi_chan_activity 0x00003FFF

wifi_max_tx_power 18 max allowed transmit power for the defined regdomain

wifi_gf_mode 0 Greenfield (high throughput) mode

wifi_reg_country IT Current regulatory domain

wifi_dtim_period 1 AP reported DTIM period (used in STA mode)

wifi_num_assoc 1 Number of the client associated to the module

ip_from_AutoIP 0 Indicates if the IP derives from AutoIP

ip_ipaddr 192.168.121.184 Current IP address

ip_netmask 255.255.252.0 Current IP netmask

ip_gw 192.168.123.20 Current IP default gateway

ip_dns1 192.168.123.20 Current IP Primary DNS server

ip_dns2 192.168.123.20 Current IP Secondary DNS server

ip_linklocal fe80:0:0:0:280:e1ff:fefa:1234 Current IPv6 linklocal

ip_local fec0:0:0:0:280:e1ff:fefa:1234 Current IPv6 local

ip_dns1v6 0:0:0:0:0:0:0:0 Current IPv6 Primary DNS Server

ip_dns2v6 0:0:0:0:0:0:0:0 Current IPv6 Secondary DNS server

5=Scan complete

6=Join in progress

7=Joined

8=Access point started

9=802.11 handshake complete

10=Ready to transmit data (i.e. “Link Up”)

Channels where we are allowed to transmit.

Channel mask. i.e. 0x00003FFF → from channel 0 to channel 13

UM2114

Variables and values

UM2114 - Rev 3

The following table lists the peer variables together with their associated values. The list of peer variables is generated by the command AT+S.PEERS.

page 48/66

Page 49

Variables and values

Table 9. Peer variables

Peers variables Value Note

AT-S.Var:n.<var> where n:0=mode connected to STA; n between 1 to 5=id of the connected client

link_id 0 Identifier of the client

0 = Hardware Power Up

1 = HW link initialization

2 = Client Link identifier allocated

state 4

addr 02:62:1F:51:8F:0B MAC address of the client

last_rx 14 Timestamp of last received packet

last_tx 14 Timestamp of last transmitted packet

rx_drops 0 Count of frames dropped during reception

tx_drops 0 Count of frames dropped during transmission

rx_pkts 22 Count of received frames

tx_pkts 24 Count of transmitted frames

tx_errs 0 Count of errors detected during frame transmit

rate_mask 0x00003FCF AP reported Operational data rate mask

cur_rate_idx 3 Most significant byte of the rate_mask

cur_rate_ok 3 Counter to perform rate step up

cur_rate_fail 0 Counter to perform rate step down

tx_consec_fail 0 Counter to perform disassociation

rx_seqnum 0x000031F0 Sequence number of last RX directed frame

rx_seqnum_mc 0x00002780 Sequence number of last RX multicast frame

rx_rssi -51 Signal strength of last received packet

rx_rateidx 13 Rate index of last received packet

setprot 3 Bitmask to indicate protection for TX (bit 1) and/or RX (bit 0) IEEE 802.11 frames

listen_interval 0 AP reported listen interval

capinfo 0x00000411 Information about the AP capabilities

3 = Authenticated

4 = Associated

5 = Peer lost beacons

6 = Peer in power save state

UM2114

UM2114 - Rev 3

page 49/66

Page 50

9 Synchronous errors and WIND messages

Synchronous errors

The following tables list the synchronous errors, each specified with its ID. The tables also show the errors that are specific to an HTTP client connection. They are characterized by the prefix AT-S.

Table 10. AT-S.ERROR:=ERROR ID= =ERROR String=

ERROR ID ERROR string

1 "Command not found"

2 "Missing argument(s)"

3 Reserved

4 "Variable not found"

5 Reserved

6 "Too many argument(s)"

7 "Invalid argument(s)"

8 "Invalid value"

9 Reserved

10 Reserved

11 Reserved

12 Reserved

13 Reserved

14 Reserved

15 Reserved

16 "Cannot switch to Python shell"

17 "Radio enabled"

18 "Radio not running"

19 "Direction must be 'in' or 'out'"

20 "Invalid GPIO Num (0-15)"

21 "Cannot use GPIO6 when sleep_enabled"

22 "Cannot use interrupt. Reserved for WPS feature"

23 "Cannot use GPIO10 when blink_led"

24 "Cannot use when SPI"

25 "Interrupt line already set"

26 "Output voltage not allowed"

27 "Frequency not supported"

28 "Duty cycle not supported"

29 "PWM not running"

30 Reserved

31 Reserved

32 "Argument exceeds allowed size"

33 "Argument evaluated to zero"

UM2114

Synchronous errors and WIND messages

UM2114 - Rev 3

page 50/66

Page 51

ERROR ID ERROR string

34 Reserved

35 Reserved

36 Reserved

37 Reserved

38 Reserved

39 "PIN needs to be 7 digits"

40 "Scan in Progress"

41 "Scan Failed"

42 "Wait for Hardware Busy"

43 "Wait for Hardware Starting"

44 "Wait for Connection Up"

45 "Unable to complete PWM setting"

46 "ADC conversion failed"

47 Reserved

48 Reserved

49 Reserved

50 "Unable to access filesystem"

51 "Unable to open file"

52 "Unable to seek file"

53 "Unable to read file"

54 "Unable to close file"

55 "Unable to rename file"

56 "Unable to delete file"

57 "Unable to open directory"

58 "Unable to read directory"

59 "Unable to (un)mount volume"

60 "IP not ready to send"

61 "Cannot renew IP address"

62 "Failed to renew IP address"

63 "DNS busy"

64 "DNS start failed"

65 "DNS address failure"

66 "Cannot update Date Time"

67 "WPS only allowed on STA mode"

68 Reserved

69 Reserved

70 Reserved

71 Closing socket

72 "Closed socket"

73 "Port already opened"

UM2114

Synchronous errors and WIND messages

UM2114 - Rev 3

page 51/66

Page 52

ERROR ID ERROR string

74 "Failed to open socket"

75 "Too many sockets"

76 "Illegal Socket ID"

77 "Pending data"

78 "Socket not connected"

79 "Write failed"

80 "No valid HTTP Client Instance ID"

81 "HTTP Client busy"

82 "Failed to release HTTP Client Instance"

83 Reserved

84 Reserved

85 Reserved

86 Reserved

87 Reserved

88 Reserved

89 Reserved

90 Reserved

91 "Low Memory"

92 Reserved

93 Reserved

94 Reserved

95 Reserved

96 Reserved

97 Reserved

98 Reserved

99 "Scan Aborted"

100 "Failed to read flash"

101 "Failed to write flash"

102 Reserved

103 Reserved

104 Reserved

105 Reserved

106 Reserved

107 Reserved

108 Reserved

109 Reserved

110 Reserved

111 "Request failed"

112 Reserved

113 Reserved

UM2114

Synchronous errors and WIND messages

UM2114 - Rev 3

page 52/66

Page 53

Synchronous errors and WIND messages

ERROR ID ERROR string

114 Reserved

115 Reserved

116 Reserved

117 Reserved

118 Reserved

119 Reserved

Table 11. AT-S.WebSocket Client Error:=Error ID=

ERROR ID Description

0 Connection Refused

2 TLS Connection Error

3 Server Resolve Error

4 HTTP Error (Parser | Generator | ProtocolSwitch)

5 HTTP Timeout

TCP error (TimeoutConn | TimeoutData | Disconnected | Send | NoTcpConnection)

UM2114

Table 12. AT-S.Http Client Error:=Error ID=

ERROR ID Description

0 Error while resolving Hostname

1 Timeout while TCP-Connect (TCP-Syn)

2 Error or timeout while TCP-Connect

3 HTTP Client refused connecting to server

4 Timeout while receiving TCP data

5 Received unexpected TCP-Disconnect while sending

6 Error while sending TCP data

7 Error during TLS connect

8 Error while generating HTTP data (HTTP-Generator)

9 Error while parsing HTTP data (HTTP-Parser)

10 Timeout for whole HTTP-Request +HTTP-Response

11 Error while Protocol switch handshake

12 Error while File access Open

13 Error while File access Close

14 Error while File access Read

15 Error while File access Write

Table 13. AT-S.Certificate Error:=Error ID=

ERROR ID Description

0 Reserved

UM2114 - Rev 3

page 53/66

Page 54

Synchronous errors and WIND messages

ERROR ID Description

1 Reserved

2 Subject certificate is null or length is zero

3 Parsing the certificate failed

4 Common name does not match (wildcard certificate)

5 Common name does not match

6 Desired key usage is not permitted

7 Parsing the AuthorityKeyId extension failed

8 Initializing decryption of signature failed

9 Decryption of signature failed

10 Invalid signature

11 Parsing the signature failed

12 Parsing the authority certificate failed

13 Missing subject key id extension

14 Parsing the SubjectKeyId extension failed

15 SubjectKeyId does not match AuthorityKeyId

16 Desired key usage is not permitted

17 Basic constraints are not good

18 Parsing the AuthorityKeyId extension failed

19 The certificate is not supported

20 The certificate has been revoked

21 The certificate has expired

22 An unspecified error has occurred

23 The CA could not be found

24 Reserved

25 Reserved

UM2114

WIND messages

The following table lists the asynchronous messages. The message format is: +WIND:<WIND ID>:<WIND Message>[:<Variables>]

Table 14. WIND messages

WIND ID WIND message Variables Description Application notes

After a reset, wait for

0 “Console active”

1 “Poweron” %s-%s-%s DATE,BUILD,MODEL

2 “Reset”

3 “Watchdog Running” %u Configured watchdog timeout

4 “Low Memory”

UM2114 - Rev 3

this wind message before sending commands

page 54/66

Page 55

UM2114

Synchronous errors and WIND messages

WIND ID WIND message Variables Description Application notes

DEAD Reason. Range of values:

1. Shown when a WiFi exception “WIND:31” happens

2. Shown when a WPA Init “WIND:50” happens

5 “WiFi Hardware Failure” %u

6 Reserved

7 “Configuration Failure” %u

8 “Hard Fault” %s:(%08x)*8 Task, name, STM32 registers content

9 “StackOverflow” %s Task name

10 “Malloc Failed” %s:%d:%d Task name, Required Size, Available Size

11 “Radio Startup Failure” %u:%08x

“WiFi PS Mode Failure %u:%d

%s nv_model configuration variable

3. Shown when startup “WIND:32” cannot be reached

4. Shown when driver is not able to write to cw1100

5. Shown when cw1100 does not send an ack within given timeout

Failure reason. Range of values:

1. Reserved

2. Reserved

3. Reserved

4. Shown when RTC cannot be initialized

5. Reserved

6. Shown when System Tick cannot be initialized

7. Shown when Flash cannot be written

8. Shown when uPython detects a fatal error

9. Shown when UART/SPI queues cannot be created

10. (Does not Halt) Shown when HW pull-up resistor has no match with enabled interface

11. (Does not Halt) Shown when Ext SPI Flash cannot be formatted

12. (Does not Halt) Shown when Ext SPI Flash cannot be mounted

13. Shown when APP disk cannot be mounted

14. Shown when RAM disk cannot be created

Failure Reason, Found register content. Range of Values

1. Shown when cw1100 Prefetch bit cannot be set

2. Shown when cw1100 Firmware cannot be uploaded

3. Shown when cw1100 is not evaluated as sane

4. Shown when cw1100 DPLL register cannot be set

5. Shown when cw1100 cannot be woken up

6. Shown when cw1100 ID low register is evaluated as bad

7. Shown when cw1100 ID medium register is evaluated as bad

8. Shown when cw1100 ID high register is evaluated as bad

9. Shown when cw1100 cannot be set in Direct Mode

10. Shown when cw1100 cannot be set in ETF Mode

Failure Reason, Found status. Range of Values

1. Shown when cw1100 is not allowing PM set

2. Shown when AP does not provide an answer within given timeout

3. Shown when cw1100 raises this event

UM2114 - Rev 3

page 55/66

Page 56

UM2114

Synchronous errors and WIND messages

WIND ID WIND message Variables Description Application notes

14 “WiFi BSS Regained” %d Threshold

15 “WiFi Signal Low” %d RSSI

16 “WiFi Signal Ok” %d RSSI

Boot %u.%u Welcome message from FW update

Aborting F/W update:%u

17 Boot Messages

18 “Keytype not implemented” %u Required Key Type

19 “WiFi Join” %m AP MAC Address

20 “WiFi Join Failed” %04x

21 “WiFi Scanning”

22 “Scan Blew Up”

23 “Scan Failed” %04x Cw1100 reply status

24 “WiFi Up” %u:%i

26 “Started AP” %s SSID

27 “AP Start Failed” %04x Cw1100 reply status

28 “Station Associated” %m:%u Peer MAC Address, Re-association flag

29 “DHCP Reply” %i:%m Peer IPv4 address, Peer MAC Address

30 “WiFi BSS Lost”

31 “WiFi Exception”

32 “WiFi Hardware Started”

33 “WiFi Network Lost”

34 “WiFi Unhandled Event” %02x Detected Event

35 “WiFi Scan Complete” %02x Aborting Reason

36 “WiFi Unhandled Indication” %02x Detected Indication

37 Reserved

”WiFi Association successful”

Performing F/W update

Completed F/W update

Cleanup Shown when mass storage is going to be erased

%s SSID

%u:%s:%08x:% 08x

Shown when FW cannot be updated (GPIO0 / CRC). Cleanup.

Shown when FW was validated (before write)

Shown when FW was updated. Cleanup

Failure Reason. Range of Values

0001 – Shown when cw1100 cannot be configured

0002 – Shown when cw1100 does not send an ack within a given timeout

0003 – shown when cw1100 cannot be configured after join operation

Shown when cw1100 reply status is evaluated as bad

IPFlag (0 → IPv4; 1 → temporary IPv4 coming from AutoIP), IPv4/6 address

Reason, File Name, cw1100 registers content

UART baudrate is hardcoded to 115200.

Message string (%s) cannot be removed through console_winds configuration variable.

It may be printed up twice with both the IP addresses. The WIND concludes the association process with the remote AP

Wait for this WIND before switching on the radio

UM2114 - Rev 3

page 56/66

Page 57

UM2114

Synchronous errors and WIND messages

WIND ID WIND message Variables Description Application notes

38 “WiFi Powered Down”

39 “HW in MiniAP Mode”

40 “WiFi Deauthentication” %u Refer to standard

41 “WiFi Disassociation” %u Refer to standard

43 “WiFi Unhandled Data” %02x Received Frame

44 “WiFi Unknown Frame” %04x Received Frame

45 “Dot11 AuthIllegal” %u:%u Authentication Algorithm, authentication sequence

46 “WPA Crunching PSK” %s:%u PSK,length

47 Reserved

48 Reserved

49 "WPA Terminated" %d Exit Status

50 "WPA Start Failed" %u

51 "WPA Handshake Complete"

52 "GPIO Interrupt" %u:%u GPIO number, level

53 "Wakeup"

54 Reserved

55 "Pending Data" %u:%u:%u:%u Server ID, Client ID, Received bytes, cumulative bytes

56 "Input to remote" %u Input ID

57 "Output from remote" %u:%s Received message length, message

58 "Socket Closed" %u:%u

“WiFi Unhandled Management”

%02x Received Frame

Failure Reason. Range Values.

1. Shown when WPA Supplicant was not able to start

2. Shown when WPA Supplicant was not able to create peer table

Client ID

Closure Reason. Values range

0.Shown when remote TCP sent a FIN

1.Shown when Remote TCP sent a RST, or did not rely

to FINACK

2.Shown when too many retransmissions have occurred

3.Shown when network layer has broken

4.Shown when a timeout occurred

5.Shown when ICMP Destination Unreachable was

received

Only printed when buffer for input request is empty. Buffer is filled and cleared by AT +S.INPUTSSI command

Maximum allowed length is 128. Every message longer than 128 will be truncated. Use multipart/formdata webserver capability to send more than 128 bytes. Refer to AN4965 "WebServer on SPWF04S module

AT+S.SOCKC/AT +S.SOCKDC needs to be called to flush the buffer and clear the socket state

UM2114 - Rev 3

page 57/66

Page 58

UM2114

Synchronous errors and WIND messages

WIND ID WIND message Variables Description Application notes

59 Reserved

60 Reserved

61 "Incoming Socket Client" %i:%u:%u:%u Client IP, client Port, server ID, client ID

62 "Socket Client Gone"

63 "Socket Dropping Data" %u:%u:%u Server ID, client ID, dropped bytes

64 "Remote Configuration" %s:%s Configuration item, configuration value

65 "Factory Reset" %u

66 "Low Power Mode" %u

67 "Going into Standby" %u Configured Standby Time

68 "Resuming from Standby"

69 "Going into DeepSleep"

70 "Resuming from DeepSleep"

71 Reserved

72 "Station Disassociated" %m:%u Peer MAC Address, reason code

74 "Rejected found Network"

75 "Rejected Association" %04x

78 "MIC Failure"

79 Reserved

80 "UDP Broadcast Received"

81 "WPS generating DH keyset"

83 "Sockd Dropping Client" %u

84 "NTP Server Delivery"

"System Configuration Updated"

"WiFi Authentication Timed Out"

"WiFi Association Timed Out"

"WPS enrollment attempt timed out"

%i:%u:%u:%u: %u

%u:%i:%u:%u:%sServer ID, Client IP, client port, datagram size, datagram

%u.%u.%u:%u: %u.%u.%u

Client IP, client Port, server ID, client ID, closure reason

Restore Reason. Values Range

0.GPIO0 high at start-up, or reset line not stable

1.CRC check failure on saved configuration

Powersave Value. Values Range

1. Standard Powersave

2. Fast Powersave

Rejection Reason. Values Range Shown when cw1100 cannot be configured

0xffff – shown when WPA Supplicant was not able allocate memory

content

Dropping reason

1. Not enough RAM to allow access to socket client

2. Too many clients are connected (only when UDP)

Year, month,day,day of week, hour, min,sec

Item called “Key” is only shown when different from user_desc password

UM2114 - Rev 3

page 58/66

Page 59

UM2114

Synchronous errors and WIND messages

WIND ID WIND message Variables Description Application notes

Failure reason. Range Values.

0. Shown when DHCP server does not respond

1. Shown when DHCP server answer has a wrong

message format

2. Shown when given timeout value is not acceptable

85 "DHCP failed to get a lease" %u

86 "MQTT Published"

87 "MQTT Closed" %u:%u

88 "WebSocket Data"

89 "WebSocket Closed" %u Client ID

90 "File Received" %i:%s

%u:%s:%u:%u: %u:%u:%u:%s

%u:%u:%u:%u:%uClient ID, lastframe flag, lastfrag flag rcv bytes,

3. Shown when received a NACK

4. Shown when DHCP server does not provide an IP

address

5. Shown when DHCP server provide a lease time

smaller than 50s

6. Shown when DHCP Lease Time expired

Client ID, topic,QoS,retain,dupl,msg siz,tot siz,msg

Closure reason (0: connection level; 1: MQTT protocol level), Client ID

cumulated bytes

AT+S.WSOCKC needs to be called to flush the buffer and clear the websocket state

Client IP (only provided if file comes from TFTP client), Filename

UM2114 - Rev 3

page 59/66

Page 60

Revision history

Table 15. Document revision history

Date Version Changes

03-Mar-2017 1 Initial release.

Added un-maskable results for ATCommands.

14-Nov-2017 2

27-Nov-2018 3

Added FW1.1.0 new features.

Added part number in Table 6. Technology partners.

Update Section 1 SPWF04Sx software

architecture description. Added Section 6.12 AT+S.FSWRITE and Section 6.28 AT+S.FSM. Minor text

changes.

UM2114

UM2114 - Rev 3

page 60/66

Page 61

UM2114

Contents

1 SPWF04Sx software architecture description ......................................2

2 Interface and message types.......................................................4

3 AT commands over the UART......................................................7

4 SPI protocol .......................................................................8

5 MicroPython Scripting ............................................................10

6 Command reference guide ........................................................11

6.1 AT ..........................................................................11

6.2 AT+S.HELP ..................................................................11

6.3 AT+S.STS ...................................................................11

6.4 AT+S.PEERS.................................................................12

6.5 AT+S.RESET.................................................................13

6.6 AT+S.PMS ...................................................................13

6.7 AT+S.PYTHON ...............................................................14

6.8 AT+S.GCFG..................................................................14

6.9 AT+S.SCFG ..................................................................14

6.10 AT+S.WCFG .................................................................15

6.11 AT+S.FCFG ..................................................................15

6.12 AT+S.FSWRITE ..............................................................15

6.13 AT+S.FSUPDATE .............................................................16

6.14 AT+S.FWUPDATE ............................................................16

6.15 AT+S.GPIOC .................................................................17

6.16 AT+S.GPIOR .................................................................17

6.17 AT+S.GPIOW.................................................................18

6.18 AT+S.DAC ...................................................................18

6.19 AT+S.ADC ...................................................................18

6.20 AT+S.PWM ..................................................................19

6.21 AT+S.TIME...................................................................19

6.22 AT+S.RANDOM...............................................................20

6.23 AT+S.FSC ...................................................................20

UM2114 - Rev 3

page 61/66

Page 62

UM2114

Contents

6.24 AT+S.FSD ...................................................................20

6.25 AT+S.FSR ...................................................................21

6.26 AT+S.FSL....................................................................21

6.27 AT+S.FSP ...................................................................22

6.28 AT+S.FSM ...................................................................22

6.29 AT+S.FSU ...................................................................22

6.30 AT+S.HASH..................................................................23

6.31 AT+S.WPAECERT ............................................................23

6.32 AT+S.TLSCERT ..............................................................24

6.33 AT+S.WPS...................................................................24

6.34 AT+S.WIFI ...................................................................25

6.35 AT+S.SCAN..................................................................25

6.36 AT+S.SSIDTXT ...............................................................26

6.37 AT+S.PING ..................................................................26

6.38 AT+S.SOCKON...............................................................26

6.39 AT+S.SOCKQ ................................................................27

6.40 AT+S.SOCKC ................................................................28

6.41 AT+S.SOCKW ................................................................28

6.42 AT+S.SOCKR ................................................................28

6.43 AT+S.SOCKL.................................................................29

6.44 AT+S.SOCKDON .............................................................29

6.45 AT+S.SOCKDQ...............................................................30

6.46 AT+S.SOCKDC ...............................................................30

6.47 AT+S.SOCKDW ..............................................................31

6.48 AT+S.SOCKDR ...............................................................31

6.49 AT+S.SOCKDL ...............................................................31

6.50 AT+S.TFTPGET ..............................................................32

6.51 AT+S.TFTPPUT ..............................................................32

6.52 AT+S.SMTP..................................................................33

6.53 AT+S.HTTPGET ..............................................................33

UM2114 - Rev 3

page 62/66

Page 63

UM2114

Contents

6.54 AT+S.HTTPPOST .............................................................34

6.55 AT+S.INPUTSSI ..............................................................35

6.56 AT+S.MQTTCONN ............................................................35

6.57 AT+S.MQTTPUB..............................................................36

6.58 AT+S.MQTTDISC .............................................................36

6.59 AT+S.MQTTSUB..............................................................37

6.60 AT+S.MQTTUNSUB ...........................................................37

6.61 AT+S.WSOCKON .............................................................37

6.62 AT+S.WSOCKQ ..............................................................38

6.63 AT+S.WSOCKC ..............................................................38

6.64 AT+S.WSOCKW ..............................................................39

6.65 AT+S.WSOCKR ..............................................................39

6.66 AT+S.WSOCKL...............................................................39

7 Technology partners ..............................................................41

8 Variables and values..............................................................42

9 Synchronous errors and WIND messages .........................................50

Variables and values................................................................. 0

Synchronous errors and WIND messages ............................................ 0

Revision history .......................................................................60

UM2114 - Rev 3

page 63/66

Page 64

UM2114

List of tables

Table 1. SPWF04Sx commands................................................................ 4

Table 2. KindOfEvent Byte SubField ............................................................. 8

Table 3. Indication number field ................................................................ 8

Table 4. Power states and configuration ......................................................... 13

Table 5. Association between file extension and HTTP content-type ...................................... 34

Table 6. Technology partners................................................................. 41

Table 7. Configuration variables ............................................................... 42

Table 8. Status variables.................................................................... 47

Table 9. Peer variables .....................................................................49

Table 10. AT-S.ERROR:=ERROR ID= =ERROR String= ...............................................50

Table 11. AT-S.WebSocket Client Error:=Error ID= ................................................... 53

Table 12. AT-S.Http Client Error:=Error ID= ........................................................ 53

Table 13. AT-S.Certificate Error:=Error ID= ........................................................ 53

Table 14. WIND messages ................................................................... 54

Table 7. Configuration variables .............................................................. 0

Table 8. Status variables ................................................................... 0

Table 9. Peer variables .................................................................... 0

Table 10. AT-S.ERROR:=ERROR ID= =ERROR String= .............................................. 0

Table 11. AT-S.WebSocket Client Error:=Error ID= .................................................. 0

Table 12. AT-S.Http Client Error:=Error ID= ....................................................... 0

Table 13. AT-S.Certificate Error:=Error ID= ....................................................... 0

Table 14. WIND messages .................................................................. 0

Table 15. Document revision history .............................................................60

UM2114 - Rev 3

page 64/66

Page 65

UM2114

List of figures

Figure 1. SPWF04Sx user integration modes ......................................................1

Figure 2. SPWF04Sx software architecture .......................................................2

Figure 3. SPWF04Sx protocol stack diagram ......................................................3

Figure 4. SPI packet formats .................................................................8

Figure 5. MicroPython modes ...............................................................10

Figure 6. AP capabilities list ................................................................. 25

UM2114 - Rev 3

page 65/66

Page 66

UM2114

IMPORTANT NOTICE – PLEASE READ CAREFULLY

STMicroelectronics NV and its subsidiaries (“ST”) reserve the right to make changes, corrections, enhancements, modifications, and improvements to ST products and/or to this document at any time without notice. Purchasers should obtain the latest relevant information on ST products before placing orders. ST products are sold pursuant to ST’s terms and conditions of sale in place at the time of order acknowledgement.

Purchasers are solely responsible for the choice, selection, and use of ST products and ST assumes no liability for application assistance or the design of Purchasers’ products.

No license, express or implied, to any intellectual property right is granted by ST herein.

Resale of ST products with provisions different from the information set forth herein shall void any warranty granted by ST for such product.

ST and the ST logo are trademarks of ST. All other product or service names are the property of their respective owners.

Information in this document supersedes and replaces information previously supplied in any prior versions of this document.

UM2114 - Rev 3

page 66/66