Bluegiga Wi-FI Software API Reference Manual Version 1.3.0

BLUEGIGA WI-FI SOFTWARE
API DOCUMENTATION
Tuesday, 2 June 2015
Version 2.2
Copyright © Silicon Labs
All rights reserved.
Silicon Labs assumes no liability or responsibility for any errors, mistakes or inaccuracies in content. Silicon
Labs reserves the right to change products or specifications without notice, and does not make any commitment
to update the information herein.
Silicon Labs’ products are not authorized for use as critical components in life support devices or systems.
The Bluetooth® word mark and logos are registered trademarks owned by the Bluetooth® SIG, Inc. USA.
All other trademarks and trade names listed herein belong to their respective owners.
Information is subject to change without notice.
Bluegiga – A Silicon Labs Company
Page 2 of 236
Table of Contents
1 Version History - WF121 SW API __________________________________________________________ 5
2 Introduction to Bluegiga Wi-Fi software ______________________________________________________ 7
2.1 Bluegiga Wi-Fi Stack _______________________________________________________________ 7
2.2 Bluegiga BGAPI protocol ____________________________________________________________ 8
2.3 Bluegiga BGLib library _____________________________________________________________ 10
2.4 Bluegiga BGScript scripting language _________________________________________________ 11
3 Understanding Endpoints _______________________________________________________________ 12
3.1 Predefined Endpoints ______________________________________________________________ 13
4 API Definition -- Wi-Fi __________________________________________________________________ 14
4.1 BGAPI protocol definition -- Wi-Fi _____________________________________________________ 14
4.1.1
Packet format _____________________________________________________________ 14
4.1.2
Message types ____________________________________________________________ 14
4.1.3
Command Class IDs ________________________________________________________ 15
4.1.4
Packet Exchange __________________________________________________________ 15
4.1.5
Introduction to BGAPI over SPI ________________________________________________ 16
4.2 BGLIB functions definition -- Wi-Fi ____________________________________________________ 16
4.3 BGScript API definition -- Wi-Fi ______________________________________________________ 18
4.4 Data types -- Wi-Fi ________________________________________________________________ 19
5 API Reference -- Wi-Fi _________________________________________________________________ 20
5.1 System--Wi-Fi ____________________________________________________________________ 21
5.1.1
Commands--system--Wi-Fi ___________________________________________________ 21
5.1.2
Events--system--Wi-Fi _______________________________________________________ 27
5.2 Configuration--Wi-Fi _______________________________________________________________ 30
5.2.1
Commands--config--Wi-Fi ____________________________________________________ 30
5.2.2
Events--config--Wi-Fi ________________________________________________________ 33
5.3 Wi-Fi--Wi-Fi _____________________________________________________________________ 34
5.3.1
Commands--SME--Wi-Fi _____________________________________________________ 34
5.3.2
Events--SME--Wi-Fi ________________________________________________________ 63
5.4 TCP stack--Wi-Fi _________________________________________________________________ 86
5.4.1
Commands--TCP/IP--Wi-Fi ___________________________________________________ 86
5.4.2
Events--TCP/IP--Wi-Fi ______________________________________________________ 111
5.5 Endpoint--Wi-Fi __________________________________________________________________ 122
5.5.1
Commands--endpoint--Wi-Fi _________________________________________________ 122
5.5.2
Events--endpoint--Wi-Fi ____________________________________________________ 132
5.5.3
Enumerations--endpoint--Wi-Fi _______________________________________________ 137
5.6 Hardware--Wi-Fi _________________________________________________________________ 138
5.6.1
Commands--hardware--Wi-Fi ________________________________________________ 138
5.6.2
Enumerations--hardware--Wi-Fi ______________________________________________ 167
5.6.3
Events--hardware--Wi-Fi ____________________________________________________ 168
5.7 I2C--Wi-Fi ______________________________________________________________________ 173
5.7.1
Commands--I2C--Wi-Fi _____________________________________________________ 173
5.8 Wired Ethernet--Wi-Fi _____________________________________________________________ 177
5.8.1
Commands--Ethernet--Wi-Fi _________________________________________________ 177
5.8.2
Events--Ethernet--Wi-Fi _____________________________________________________ 181
5.9 HTTP Server--Wi-Fi ______________________________________________________________ 182
5.9.1
Commands--HTTPS--Wi-Fi __________________________________________________ 182
5.9.2
Events--HTTPS--Wi-Fi _____________________________________________________ 188
5.10 Persistent Store--Wi-Fi ___________________________________________________________ 192
5.10.1
Commands--Flash--Wi-Fi __________________________________________________ 192
5.10.2
Enumerations--Flash--Wi-Fi ________________________________________________ 199
5.10.3
Events--Flash--Wi-Fi ______________________________________________________ 201
5.11 Device Firmware Upgrade--Wi-Fi ___________________________________________________ 204
5.11.1
Commands--DFU--Wi-Fi ___________________________________________________ 204
5.11.2
Events--DFU--Wi-Fi _______________________________________________________ 208
5.12 Utilities for BGScript--Wi-Fi ________________________________________________________ 209
5.12.1
Commands--Util--Wi-Fi ____________________________________________________ 209
5.13 SD card--Wi-Fi _________________________________________________________________ 211
5.13.1
Commands--SDHC--Wi-Fi __________________________________________________ 211
Bluegiga – A Silicon Labs Company
Page 3 of 236
5.14
5.13.2
Events--SDHC--Wi-Fi _____________________________________________________ 228
Error codes -- Wi-Fi _____________________________________________________________ 232
5.14.1
BGAPI Errors--Wi-Fi ______________________________________________________ 232
5.14.2
Hardware Errors--Wi-Fi ____________________________________________________ 233
5.14.3
TCP/IP Errors--Wi-Fi ______________________________________________________ 234
Bluegiga – A Silicon Labs Company
Page 4 of 236
1 Version History - WF121 SW API
Version
0.9
API documentation for SW version v.0.3.0 (Build 25).
0.95
I2C API descriptions added, I2C and SPI end-points added, the power state management API
added
1.0
Updated to be compliant with SW version 1.0: ADC read command added, Output Compare
command added, e.g., PWM purposes
1.2
Wi-Fi Access point and HTTP server commands and event added and updated (see Wi-Fi and
HTTP Server chapters)
PS Key Change event added for monitoring PS key changes
UDP Data event added for seeing the source of UDP data
Event for handling invalid commands added
1.3
Improved the documentation regarding how to use BGAPI over SPI
1.4
Documentation updates for SW v1.2.1 compatibility
Added/Changed APIs:
WPS commands and events added under Wi-Fi commands
Ethernet commands and event added
Get Signal Quality command and respective event added under Wi-Fi section
UDP Bind command for defining the source port added under TCP commands
Command setting maximum number of clients for AP mode added
For endpoints, the Error and SyntaxError events added
RTC commands and event added under Hardware section
State event (internal state for Wi-Fi SW) under System removed as not usable by 3rd party
SW
Editorial modifications:
Possible events for commands are added
Error and return codes are updated
1.5
Documentation updates for SW v1.2.2 compatibility
Added/Changed APIs:
Set DHCP Host Name API added for including host name parameter
Set transmit packet size API added for a TCP/UDP endpoint
WPS support information added into the scan results event
Connecting to Hidden SSID support added for Connect to SSID command (no API change)
1.6
Improved API documentation
1.7
Improved API documentation
Bluegiga – A Silicon Labs Company
Page 5 of 236
Version
2.0
Documentation updates for SW v1.3.0 compatibility
Added/Changed APIs:
Set Max Power Saving State includes Deep Sleep Mode parameter
EAP commands under WiFi category added for WPA enterprise functionality
SSL/TLS commands and event under TCP Stack category added for enabling SSL/TLS
communication
X.509 command and event category introduced for managing the certificates and certificate
storage
UART configuration and enabling/disabling commands and event under Hardware category
added
Ethernet routing options extended for Set Dataroute command under Wired Ethernet
category
Multiple HTTP commands and events under HTTP server category for enabling more
flexible HTTP server usage
Low Voltage event under Flash category introduced for detecting an error when writing to
Flash and low voltage supplied
SD Card command and event category added for managing files on the external SD card
BGScript utility command category added for enabling integer and string conversions with
BGScript
Removed API's
Button and On Req events under HTTP server category removed.
2.1
Editorial changes
2.2
Documentation updates for SW v1.3.0 compatibility
Added/Changed APIs:
802.11n mode command added under Wi-Fi category
Access point visibility command added under Wi-Fi category
A number of new error/reason codes added under Error codes category
mDNS commands and events added under TCP/IP category
DNS-SD commands and events added under TCP/IP category
DHCP routing options command added under TCP/IP category
Removed API's
EAP commands under WiFi category added for WPA enterprise functionality
SSL/TLS commands and event under TCP Stack category added for enabling SSL/TLS
communication
X.509 command and event category introduced for managing the certificates and certificate
storage
Bluegiga – A Silicon Labs Company
Page 6 of 236
2 Introduction to Bluegiga Wi-Fi software
The Bluegiga Wi-Fi Software contains complete 802.11 MAC and IP networking stacks, providing everything
required for creating wireless devices to integrate with existing Wi-Fi infrastructure.
The Wi-Fi Software supports three different modes of use:
Standalone architecture: all software including the Wi-Fi stack and the application software run on the
MCU of WF121 module
Hosted architecture: an external MCU runs the application software which controls the WF121 module
using BGAPI protocol
Mixed architecture: part of the application run on the MCU of WF121 module and rest on an external
MCU
In all above cases, the Bluegiga Wi-Fi Software provides a complete 802.11 MAC and IP networking stacks, so
no additional 802.11 or IP stack software is required allowing simple and fast application development.
Also a well-defined binary based transport protocol called BGAPI exists between the external host and the
WF121 module as well as a simple and free software development kit to aid with development.
Several components make up the Wi-Fi Software Development Kit:
A 802.11 MAC stack for controlling Wi-Fi functionality
An IP networking stack for using various networking protocols such as TCP, UDP, DHCP and DNS
Binary based communication protocol (BGAPI) between the host and the module
A C library (BGLib) for the host that implements the BGAPI protocol
BGScript scripting language and interpreter for implementing applications on the WF121 module's
internal MCU
A WIFIGUI application to quickly test, prototype and explore the functionality of the module
2.1 Bluegiga Wi-Fi Stack
The integrated Wi-Fi stack provides the necessary functions to scan for access points, configure the encryption
and connect to access points. The protocol stack is illustrated below.
Bluegiga – A Silicon Labs Company
Page 7 of 236
Figure: Bluegiga Wi-Fi Software
2.2 Bluegiga BGAPI protocol
For applications where a separate host (MCU) is used to implement the end user application, a transport
protocol is needed between the host and the Wi-Fi stack. The transport protocol is used to communicate with
the Wi-Fi stack as well to transmit and receive data packets. This protocol is called BGAPI and it's a binary
based communication protocol designed specifically for ease of implementation within host devices with limited
resources.
The BGAPI provides access to the following layers:
System - Various system functions, such as querying the hardware status or reset it
Configuration - Provides access to the devices parameters such as the MAC address
TCP stack - Gives access to the TCP/IP stack and various protocols like TCP and UDP
SME - Provides access to 802.11 MAC and procedures like access point discovery
Endpoint - Provides functions to control the data endpoints
Hardware - An interface to access the various hardware layers such as timers, ADC and other hardware
interfaces
Persistent Store - Allows user to read/write data to non-volatile memory
Device Firmware Upgrade - Provides access to firmware update functions
The BGAPI protocol is intended to be used with:
a serial UART link
Bluegiga – A Silicon Labs Company
Page 8 of 236
Figure: BGAPI messaging
Bluegiga – A Silicon Labs Company
Page 9 of 236
2.3 Bluegiga BGLib library
For easy implementation of BGAPI protocol, an ANSI C host library is available. The library is easily portable
ANSI C code delivered within the Bluegiga Wi-Fi Software Development Kit. The purpose is to simplify the
application development to various host environments.
Figure: BGLib library
Bluegiga – A Silicon Labs Company
Page 10 of 236
2.4 Bluegiga BGScript scripting language
Bluegiga's Wi-Fi software allows application developers to create standalone devices without the need of a
separate host. The WF121 Wi-Fi module can run simple applications along the Wi-Fi stack and this provides a
benefit when one needs to minimize the end product size, cost and current consumption. For developing
standalone Wi-Fi applications the development kit provides a simple BGScript scripting language. With
BGScript provides access to the same software and hardware interfaces as the BGAPI protocol. The BGScript
code can be developed and compiled with free tools provided by Bluegiga.
Figure: BGScript architecture
Bluegiga – A Silicon Labs Company
Page 11 of 236
3 Understanding Endpoints
Endpoints play a crucial role in how data is handled and routed inside the Bluegiga Wi-Fi stack. The concept is
used to unify the handling of data between different interfaces and peripherals, both externally and internally.
As the name suggests, an endpoint describes where the data ends up going, i.e. the sink for the data. Each
data sink has an identifying endpoint number (ID) and the Wi-Fi stack will give each new endpoint the first
available number. For example if the module is configured to have a TCP server, upon an incoming TCP
connection the Wi-Fi stack will look at what the next available endpoint number is, and give the new connection
that number. In the future if any data needs to be written to that socket, it is done by writing to that endpoint
number. Since the socket also receives incoming data, the endpoint for where that data is routed, can be
configured.
It is important to understand that with bi-directional peripherals, such as a serial port or TCP socket where data
can move both in to and out of the Wi-Fi module, the system is configured through configuring the "endpoints"
for each of the peripherals. For example to route the data in both directions between a serial port and a TCP
socket, the serial port is configured to have the socket as its endpoint, and the socket is configured to have the
serial port as its endpoint.
An endpoint can either be configured to be active or inactive. By default endpoints which can receive or send
data are active, but in some cases it may be useful to temporarily inhibit the flow of data. This can be done by
setting the active flag on the endpoint to be false. Server endpoints, such as a TCP server endpoint waiting for
a connection, are always inactive, as they will not send nor can they receive data.
A typical active endpoint will automatically stream its data to its configured endpoint. However for UART
endpoints it is possible to make the endpoint an API endpoint. This is done by setting streaming to false.
Configuring endpoints individually, instead of simply tying together a TCP socket to a serial port allows for much
more flexibility. In a sensor application for example, it might be interesting to have the sensor stream data
directly to a server, while anything written by the server to the module can be routed to the BGScript instead of
going to the sensor.
FIGURE: Example of routing a bi-directional stream between different endpoints. The serial interface
has the socket configured as its endpoint, while the socket has the BGScript as its endpoint.
If an external micro-controller is used, the setup could look quite similar. In the figure below, the data from the
server would get sent to the micro-controller, and the sensor would send its data straight to the Server.
Bluegiga – A Silicon Labs Company
Page 12 of 236
FIGURE: Example of routing a bi-directional stream between different endpoints.
3.1 Predefined Endpoints
There are a few endpoints that are predefined upon boot, to provide access to some of the hardware interfaces:
Endpoint
UART
SPI
I2C
other
Note
0
UART1
SPI3
I2C3
1
UART2
SPI4
I2C5
2
BGScript
Application code processing. Can be disabled via an API
command to selectively prevent a BGScript application from
catching events and therefore running any of its code.
3
USB
4
I2C1
5-30
31
Created at run-time by the BGScript code or BGAPI
commands.
Drop
Anything sent to this endpoint will be dropped. Can be used
as "/dev/null" for streaming data.
Bluegiga – A Silicon Labs Company
Page 13 of 236
4 API Definition -- Wi-Fi
This section contains the generic Bluegiga Wi-Fi software API definition. The definition consists of three parts:
The BGAPI protocol definition
The BGLib C library description
The BGScript scripting API description
This section of the document only provides the generic definition and description of the API, the actual
commands, responses and events are described in the API reference section.
4.1 BGAPI protocol definition -- Wi-Fi
4.1.1 Packet format
Packets in either direction use the following format.
Table: BGAPI packet format
Octet
Octet bits
Length
Description
Notes
Octet 0
7
1 bit
Message Type (MT)
0: Command/Response
1: Event
...
6:3
4 bits
Technology Type (TT)
0000: Bluetooth 4.0 single mode
0001: Wi-Fi
...
2:0
3 bits
Length High (LH)
Payload length (high bits)
Octet 1
7:0
8 bits
Length Low (LL)
Payload length (low bits)
Octet 2
7:0
8 bits
Class ID (CID)
Command class ID
Octet 3
7:0
8 bits
Command ID (CMD)
Command ID
Octet 4-n
-
0 - 2048 Bytes
Payload (PL)
Up to 2048 bytes of payload
4.1.2 Message types
The following message types exist in the BGAPI protocol.
Table: BGAPI message types
Message type
Value
Description
Command
0x00
Command from host to the stack
Response
0x00
Response from stack to the host
Event
0x80
Event from stack to the host
Bluegiga – A Silicon Labs Company
Page 14 of 236
4.1.3 Command Class IDs
The command classes are defined in the API Reference chapter.
4.1.4 Packet Exchange
The BGAPI protocol is a simple command / response protocol similar to AT commands, but instead of ASCII the
BGAPI protocol uses binary format.
NOTE! The host should wait for the response to a command BEFORE issuing another command.
Figure: BGAPI messaging
Bluegiga – A Silicon Labs Company
Page 15 of 236
4.1.5 Introduction to BGAPI over SPI
When using SPI as the host interface to the Wi-Fi module, the host controller is the SPI Master and Wi-Fi
module is the SPI Slave. SPI is a synchronous interface which means that the same clock drives both the input
and the output. SPI Master sends BGAPI commands and at the same time reads possible events or responses
from the SPI Slave.
Using BGAPI over SPI
The SPI Slave informs the master by using the notify pin (I/O port) when there is data to be read. If the SPI
Slave has no data to send. it sends byte value 0. SPI Master must synchronize incoming packets to first
nonzero byte. If the SPI Slave is sending a packet, the SPI Master must clock enough zeros for the SPI Slave to
be able to send a full packet. Then the SPI Master must wait for a response packet for the command that was
sent before sending a new command packet.
Examples
Command & Response
1. SPI Master sends I/O port read command to the SPI Slave. SPI Slave responds by sending back 0's.
Master
08
03
06
07
01
FF
FF
Slave
00
00
00
00
00
00
00
2. SPI Slave notifies the SPI Master with the notify pin (assuming that the pin has been configured properly) that
it has data to send.
3. SPI Master reads the response from the SPI Slave.
Master
00
00
00
00
00
00
00
00
00
Slave
08
05
06
07
00
00
01
CD
AB
Event
1. SPI Slave notifies the SPI Master with the notify pin (assuming that the pin has been configured properly) that
it has data to send.
2. SPI Master reads the event by sending 0's to the SPI Slave, until all the data has been received from the SPI
Slave.
Master
00
00
00
00
00
00
00
00
00
Slave
88
05
06
02
04
78
56
34
12
4.2 BGLIB functions definition -- Wi-Fi
All the BGAPI commands are also available as ANSI C functions as a separate host library called BGLib. The
responses and event on the other hand are handled as function call backs. The ANSI C functions are also
documented in the API reference section.
The functions and callbacks are documented as follows:
Bluegiga – A Silicon Labs Company
Page 16 of 236
C Functions
/* Function */
void wifi_cmd_system_hello(
void
);
/* Callback *
void wifi_rsp_system_hello(
const void *nul
)
The command parameters and return values are the same as used in the BGAPI binary protocol and they are
not documented separately.
Callback programming
Callback programming is a style of computer programming, which allows lower layer of software to call functions
defined on a higher layer. Callback is piece of code or a reference to a piece of code that is passed as an
argument. The figure below illustrates the callback architecture used with BGLib.
Figure: Callback arhitectureIf you are not familiar with callback programming a basic tutorial can for
example be found from here:
http://www.codeguru.com/cpp/cpp/cpp_mfc/callbacks/article.php/c10557
Bluegiga – A Silicon Labs Company
Page 17 of 236
4.3 BGScript API definition -- Wi-Fi
The BGScript functions are also documented in the API reference section. The format of the commands varies
slightly from the C-library functions and instead of using call backs the BGScript functions take the return values
as parameters.
BGScript commands are documented as follows:
BGScript Functions
call system_hello()
The BGScript command parameters and return values are the same as used in the BGAPI binary protocol and
they are not documented separately.
Bluegiga – A Silicon Labs Company
Page 18 of 236
4.4 Data types -- Wi-Fi
Data types used in the documentation is shown in the table below.
Table: Data types used in the documentation
Name
Length
Human
readable
Script
equivalent
Description
uint8
1 byte
5
Number
A positive integer in the range 0 - 255 (inclusive)
int8
1 byte
-13
Number
An integer in the range -127 - 128 (inclusive)
uint16
2 bytes
1034
Number
A positive integer in little endian format
int16
2 bytes
1232
Number
A signed integer in little endian format
uint32
4 bytes
70000
See note
A positive integer in little endian format
int32
4 bytes
-69876
Number
A signed integer in little endian format
hw_addr
6 bytes
00:07:80:
12:34:56
Array of 6
bytes
Also called MAC address
ipv4
4 bytes
192.168.1.1
Array of 4
bytes
IPv4 address in big endian format
"Hello"
Array
The first byte is the length followed by a variable number
of bytes. This means that the maximum size of the
payload of a uint8array is 255 bytes.
uint8array 1 - n
The script's number type is internally a signed 32-bit integer. This means large unsigned 32-bit integer numbers
in API (uint32) will be represented by negative numbers in the script. This is a known limitation.
Bluegiga – A Silicon Labs Company
Page 19 of 236
5 API Reference -- Wi-Fi
This section of the document contains the actual API description with description of commands, responses,
events and enumerations. The categorization is based on command classes, which are listed below:
Description
Explanation
System
This class contains commands related to various system functions
Examples: Wi-Fi module system reset, power saving state selection
Configuration
This class contains commands related to device parameter configuration
Examples: Read MAC address, set MAC address
Wi-Fi
This class contains commands related to 802.11 MAC
Examples: Wi-Fi on, Wi-Fi off, start scan, stop scan
TCP stack
This class contains commands related to TCP/IP stack and various protocols such as
TCP and UDP and IP address setup
Examples: Configure local IP address, netmask and gateway, configure DNS client
settings
Endpoint
This class contains commands related to data endpoint control including creation and
deletion of endpoints and data routing
Examples: Activate or deactivate an endpoint, set desired transmit packet size
Hardware
This class contains commands related to hardware peripherals and interfaces
Examples: Read Wi-Fi module internal AD converter, I/O port read and write
I2C
This class contains commands related to I2C peripherals
Example: Start read, stop read
Wired Ethernet
This class contains commands related to the RMII (Ethernet) interface of the Wi-Fi
module
Examples: Test wired Ethernet connection, close wired Ethernet connection
HTTP Server
This class contains commands related to Web server activation and management
Example: Add mapping between an HTTP server URL and storage device
Persistent store
(PS)
This class contains commands related to non-volatile memory
Examples: Store a value into defined PS key, defragment persistent store
Device Firmware
Upgrade
This class contains commands related to firmware update
Examples: Reset system into DFU mode, upload firmware update file into Wi-Fi module
Utilities for
BGScript
This class contains commands related to BGScript programming language utilities
Example: Convert decimal value from ASCII string to a 32-bit signed integer
SD card
This class contains commands related to the Wi-Fi module SD memory card interface
Example: Close file, delete file
The final section of the API reference contains descriptions of the error codes which are categorized as follows:
Description
BGAPI errors
TCPIP errors
Hardware errors
Bluegiga – A Silicon Labs Company
Page 20 of 236
5.1 System--Wi-Fi
This class contains commands related to various system functions.
5.1.1 Commands--system--Wi-Fi
These commands are related to the system.
Hello--system--Wi-Fi
This command can be used to check whether communication between the Wi-Fi software and hardware
functions.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x00
lolen
Minimum payload length
2
0x01
class
Message class: System
3
0x02
method
Message ID
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x00
lolen
Minimum payload length
2
0x01
class
Message class: System
3
0x02
method
Message ID
C Functions
/* Function */
void wifi_cmd_system_hello(
void
);
/* Callback *
void wifi_rsp_system_hello(
const void *nul
)
BGScript Functions
call system_hello()
Bluegiga – A Silicon Labs Company
Page 21 of 236
Reset--system--Wi-Fi
This command can be used to reset the Wi-Fi module. This command does not have a response, but it triggers
the Boot event.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x01
lolen
Minimum payload length
2
0x01
class
Message class: System
3
0x01
method
Message ID
4
uint8
dfu
Selects the boot mode
0: boot to main program
1: boot to DFU
Table: EVENTS
event
Description
system_boot
Sent after the device has booted into normal mode
dfu_boot
Sent after the device has booted into DFU mode
C Functions
/* Function */
void wifi_cmd_system_reset(
uint8 dfu
);
BGScript Functions
call system_reset(dfu)
Bluegiga – A Silicon Labs Company
Page 22 of 236
Set Max Power Saving State--system--Wi-Fi
This command can be used to set the maximum power saving state allowed for the Wi-Fi module.
Mode 0: No power saving is in use. Use this mode for the lowest latency and best performance.
Mode 1: The Wi-Fi radio is allowed to sleep and it will automatically go to sleep after 6000 ms of
inactivity.
Mode 2: Both MCU and Wi-Fi radio are allowed to go to sleep after an inactivity timeout defined in the
hardware configuration file. The module wakes up automatically every eight (8) seconds to check for
scheduled tasks and it also generates Power Saving State event to notify the host of the scheduled
wake up.
If the <sleep> configuration is not used in the hardware configuration file then only states 0 and 1 are
possible.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x01
lolen
Minimum payload length
2
0x01
class
Message class: System
3
0x03
method
Message ID
4
uint8
state
Max allowed power saving state
0 : low latency, high performance
1 : save power, fast wake-up
2 : deep sleep, requires external interrupt to wake up
Default:
2
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x01
class
Message class: System
3
0x03
method
Message ID
4-5
uint16
result
Result code
0: success
Non-zero: an error occurred
For other values refer to the error code documentation
Bluegiga – A Silicon Labs Company
Page 23 of 236
C Functions
/* Function */
void wifi_cmd_system_set_max_power_saving_state(
uint8 state
);
/* Callback */
struct wifi_msg_system_set_max_power_saving_state_rsp_t{
uint16 result
}
void wifi_rsp_system_set_max_power_saving_state(
const struct wifi_msg_system_set_max_power_saving_state_rsp_t * msg
)
BGScript Functions
call system_set_max_power_saving_state(state)(result)
Bluegiga – A Silicon Labs Company
Page 24 of 236
Sync--system--Wi-Fi
This command can be used to synchronize the system state. When the sync command is sent, multiple events
are output representing the system status. This command can be used to synchronize the host software's status
with the Wi-Fi software's status.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x00
lolen
Minimum payload length
2
0x01
class
Message class: System
3
0x00
method
Message ID
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x00
lolen
Minimum payload length
2
0x01
class
Message class: System
3
0x00
method
Message ID
Table: EVENTS
event
Description
sme_wifi_is_on
Sent if Wi-Fi has been switched on
sme_wifi_off
Sent if Wi-Fi has been switched off
sme_scan_result
Sent for each cached scan result
sme_connected
Device connection status
tcpip_endpoint_status
Sent for each TCP/IP endpoint
endpoint_status
Sent for each endpoint
config_mac_address
Device MAC address
tcpip_configuration
Device TCP/IP configuration
tcpip_dns_configuration
Device DNS configuration
C Functions
/* Function */
void wifi_cmd_system_sync(
void
);
/* Callback *
void wifi_rsp_system_sync(
const void *nul
)
Bluegiga – A Silicon Labs Company
Page 25 of 236
BGScript Functions
call system_sync()
Bluegiga – A Silicon Labs Company
Page 26 of 236
5.1.2 Events--system--Wi-Fi
These events are related to the system.
Boot--system--Wi-Fi
This event indicates that the device has started and is ready to receive commands.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x0E
lolen
Minimum payload length
2
0x01
class
Message class: System
3
0x00
method
Message ID
4-5
uint16
major
Major release version
6-7
uint16
minor
Minor release version
8-9
uint16
patch
Patch release version
10 - 11
uint16
build
Build number
12 - 13
uint16
bootloader_version
Bootloader version
14 - 15
uint16
tcpip_version
TCP/IP stack version
16 - 17
uint16
hw
Hardware version
C Functions
/* Callback */
struct wifi_msg_system_boot_evt_t{
uint16 major,
uint16 minor,
uint16 patch,
uint16 build,
uint16 bootloader_version,
uint16 tcpip_version,
uint16 hw
}
void wifi_evt_system_boot(
const struct wifi_msg_system_boot_evt_t * msg
)
BGScript Functions
event system_boot(major, minor, patch, build, bootloader_version, tcpip_version, hw)
Bluegiga – A Silicon Labs Company
Page 27 of 236
Power Saving State--system--Wi-Fi
This event indicates the power saving state into which the module has entered.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x01
lolen
Minimum payload length
2
0x01
class
Message class: System
3
0x03
method
Message ID
4
uint8
state
See Set Max Power Saving State
C Functions
/* Callback */
struct wifi_msg_system_power_saving_state_evt_t{
uint8 state
}
void wifi_evt_system_power_saving_state(
const struct wifi_msg_system_power_saving_state_evt_t * msg
)
BGScript Functions
event system_power_saving_state(state)
Bluegiga – A Silicon Labs Company
Page 28 of 236
SW Exception--system--Wi-Fi
This event indicates that a software exception has occurred.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x05
lolen
Minimum payload length
2
0x01
class
Message class: System
3
0x02
method
Message ID
4-7
uint32
address
Address where exception occurred
8
uint8
type
Type of exception.
C Functions
/* Callback */
struct wifi_msg_system_sw_exception_evt_t{
uint32 address,
uint8 type
}
void wifi_evt_system_sw_exception(
const struct wifi_msg_system_sw_exception_evt_t * msg
)
BGScript Functions
event system_sw_exception(address, type)
Bluegiga – A Silicon Labs Company
Page 29 of 236
5.2 Configuration--Wi-Fi
This class contains commands related to device parameter configuration.
5.2.1 Commands--config--Wi-Fi
These commands are related to configuring the device.
Get MAC--config--WIFI
This command can be used to read the IEEE address of the device.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x01
lolen
Minimum payload length
2
0x02
class
Message class: Configuration
3
0x00
method
Message ID
4
uint8
hw_interface
The hardware interface to use
0: Wi-Fi
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x03
lolen
Minimum payload length
2
0x02
class
Message class: Configuration
3
0x00
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero: an error occurred
For other values refer to the error code documentation
6
uint8
hw_interface
Always zero for Wi-Fi client
Table: EVENTS
event
Description
config_mac_address
Device MAC address
Bluegiga – A Silicon Labs Company
Page 30 of 236
C Functions
/* Function */
void wifi_cmd_config_get_mac(
uint8 hw_interface
);
/* Callback */
struct wifi_msg_config_get_mac_rsp_t{
uint16 result,
uint8 hw_interface
}
void wifi_rsp_config_get_mac(
const struct wifi_msg_config_get_mac_rsp_t * msg
)
BGScript Functions
call config_get_mac(hw_interface)(result, hw_interface)
Bluegiga – A Silicon Labs Company
Page 31 of 236
Set MAC--config--Wi-Fi
This command can be used to write an IEEE address into the device.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x07
lolen
Minimum payload length
2
0x02
class
Message class: Configuration
3
0x01
method
Message ID
4
uint8
hw_interface
The hardware interface to use
0: Wi-Fi
5 - 10
hw_addr
mac
The new MAC address to set
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x03
lolen
Minimum payload length
2
0x02
class
Message class: Configuration
3
0x01
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
6
uint8
hw_interface
Always zero for Wi-Fi client
C Functions
/* Function */
void wifi_cmd_config_set_mac(
uint8 hw_interface,
hw_addr mac
);
/* Callback */
struct wifi_msg_config_set_mac_rsp_t{
uint16 result,
uint8 hw_interface
}
void wifi_rsp_config_set_mac(
const struct wifi_msg_config_set_mac_rsp_t * msg
)
BGScript Functions
call config_set_mac(hw_interface, mac)(result, hw_interface)
Bluegiga – A Silicon Labs Company
Page 32 of 236
5.2.2 Events--config--Wi-Fi
These events are related to configuration of the device.
MAC Address--config--Wi-Fi
This event indicates the current MAC address of the device.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x07
lolen
Minimum payload length
2
0x02
class
Message class: Configuration
3
0x00
method
Message ID
4
uint8
hw_interface
The hardware interface to use
0: Wi-Fi
5 - 10
hw_addr
mac
The current MAC address
C Functions
/* Callback */
struct wifi_msg_config_mac_address_evt_t{
uint8 hw_interface,
hw_addr mac
}
void wifi_evt_config_mac_address(
const struct wifi_msg_config_mac_address_evt_t * msg
)
BGScript Functions
event config_mac_address(hw_interface, mac)
Bluegiga – A Silicon Labs Company
Page 33 of 236
5.3 Wi-Fi--Wi-Fi
This class contains commands related to 802.11 MAC.
5.3.1 Commands--SME--Wi-Fi
These commands are related to Wi-Fi.
Wi-Fi On--SME--Wi-Fi
This command can be used to turn on the 802.11 radio.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x00
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x00
method
Message ID
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x00
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
Table: EVENTS
event
Description
sme_wifi_is_on
Sent after Wi-Fi has been switched on
C Functions
/* Function */
void wifi_cmd_sme_wifi_on(
void
);
/* Callback */
struct wifi_msg_sme_wifi_on_rsp_t{
uint16 result
}
void wifi_rsp_sme_wifi_on(
const struct wifi_msg_sme_wifi_on_rsp_t * msg
)
Bluegiga – A Silicon Labs Company
Page 34 of 236
BGScript Functions
call sme_wifi_on()(result)
Bluegiga – A Silicon Labs Company
Page 35 of 236
Wi-Fi Off--SME--Wi-Fi
This command can be used to turn off the 802.11 radio.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x00
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x01
method
Message ID
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x01
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
Table: EVENTS
event
Description
sme_wifi_off
Sent after Wi-Fi has been switched off
C Functions
/* Function */
void wifi_cmd_sme_wifi_off(
void
);
/* Callback */
struct wifi_msg_sme_wifi_off_rsp_t{
uint16 result
}
void wifi_rsp_sme_wifi_off(
const struct wifi_msg_sme_wifi_off_rsp_t * msg
)
BGScript Functions
call sme_wifi_off()(result)
Bluegiga – A Silicon Labs Company
Page 36 of 236
Set Scan Channels--SME--Wi-Fi
This command can be used to set the default scan channel list for commands Start Scan and Connect Ssid.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x09
method
Message ID
4
uint8
hw_interface The hardware interface to use.
0 : Wi-Fi
5
uint8array chList
List of channels to scan.
By default all channels (1 to 13) are used if this command is never used.
Set a subset of the channels to scan by filling the list in order of priority.
(See BGScript example below).
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x09
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
C Functions
/* Function */
void wifi_cmd_sme_set_scan_channels(
uint8 hw_interface,
uint8 chList_len,
const uint8* chList_data
);
/* Callback */
struct wifi_msg_sme_set_scan_channels_rsp_t{
uint16 result
}
void wifi_rsp_sme_set_scan_channels(
const struct wifi_msg_sme_set_scan_channels_rsp_t * msg
)
BGScript Functions
call sme_set_scan_channels(hw_interface, chList_len, chList_data)(result)
BGScript - Example 1
Bluegiga – A Silicon Labs Company
Page 37 of 236
Scan only channels 1, 3 and 13 starting from channel 3, then 13 and finally 1:
call sme_set_scan_channels(0, 3, "\x03\x0d\x01")
Bluegiga – A Silicon Labs Company
Page 38 of 236
Start Scan--SME--Wi-Fi
This command initiates a scan for Access Points. Scanning is not possible once connected.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x03
method
Message ID
4
uint8
hw_interface The hardware interface to use.
0 : Wi-Fi
5
uint8array chList
The list of channels which will be scanned for Access Points.
Empty list means scan channels according to configuration of Set Scan
Channels.
Fill the list to override the configuration of the Set Scan Channels. (See
BGScript examples below.)
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x03
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
Table: EVENTS
event
Description
sme_scan_result
Sent for each Access Point
sme_scan_result_drop
Sent for each dropped Access Point
sme_scanned
Sent after scan completes
Bluegiga – A Silicon Labs Company
Page 39 of 236
C Functions
/* Function */
void wifi_cmd_sme_start_scan(
uint8 hw_interface,
uint8 chList_len,
const uint8* chList_data
);
/* Callback */
struct wifi_msg_sme_start_scan_rsp_t{
uint16 result
}
void wifi_rsp_sme_start_scan(
const struct wifi_msg_sme_start_scan_rsp_t * msg
)
BGScript Functions
call sme_start_scan(hw_interface, chList_len, chList_data)(result)
BGScript - Example 1
Scan channels according to configuration in Set Scan Channels:
call sme_start_scan(0, 0, "")
BGScript - Example 2 - Scan only channels 2, 3 and 13 starting from channel 3, then 13 and finally 2 (overrides
the configuration of Set Scan Channels):
call sme_start_scan(0, 3, "\x03\x0d\x02")
Bluegiga – A Silicon Labs Company
Page 40 of 236
Stop Scan--SME--Wi-Fi
This command can be used to terminate the active scanning procedure.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x00
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x04
method
Message ID
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x04
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
Table: EVENTS
event
Description
sme_scanned
Sent after scan stopped
C Functions
/* Function */
void wifi_cmd_sme_stop_scan(
void
);
/* Callback */
struct wifi_msg_sme_stop_scan_rsp_t{
uint16 result
}
void wifi_rsp_sme_stop_scan(
const struct wifi_msg_sme_stop_scan_rsp_t * msg
)
BGScript Functions
call sme_stop_scan()(result)
Bluegiga – A Silicon Labs Company
Page 41 of 236
Connect BSSID--SME--Wi-Fi
This command can be used to try to connect to a specific Access Point using its unique BSSID. In order to
succeed, this command requires a preceding sme_start_scan command and that the desired wireless network
was found during that scan. If the Access Point is using channel 12 or 13, for the connection to be successful at
least one of the Access Points found within radio coverage range must advertise the use of channels up to 13.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x06
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x06
method
Message ID
4-9
hw_addr
bssid
The BSSID of the Access Point that the module should connect to
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x09
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x06
method
Message ID
4-5
uint16
result
Result code
0: success
Non-zero : an error occurred
Error code 180 is typical if the wireless network was not found in the
preceding scan.
For other values refer to the error code documentation
6
uint8
hw_interface Hardware interface
0 : Wi-Fi
712
hw_addr bssid
The BSSID of the Access Point that the module will attempt to connect to
Table: EVENTS
event
Description
sme_connect_retry
Sent when a connection attempt fails and is automatically retried
sme_connected
Sent when connection succeeds
sme_connect_failed
Sent when connection fails
sme_interface_status
Sent after Wi-Fi interface is ready
Bluegiga – A Silicon Labs Company
Page 42 of 236
C Functions
/* Function */
void wifi_cmd_sme_connect_bssid(
hw_addr bssid
);
/* Callback */
struct wifi_msg_sme_connect_bssid_rsp_t{
uint16 result,
uint8 hw_interface,
hw_addr bssid
}
void wifi_rsp_sme_connect_bssid(
const struct wifi_msg_sme_connect_bssid_rsp_t * msg
)
BGScript Functions
call sme_connect_bssid(bssid)(result, hw_interface, bssid)
Bluegiga – A Silicon Labs Company
Page 43 of 236
Disconnect--SME--Wi-Fi
This command can be used to disconnect from the currently connected Access Point.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x00
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x08
method
Message ID
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x03
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x08
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
6
uint8
hw_interface
Hardware interface
0 : Wi-Fi
Table: EVENTS
event
Description
sme_disconnected
Sent after disconnected
sme_interface_status
Sent after Wi-Fi interface is down
C Functions
/* Function */
void wifi_cmd_sme_disconnect(
void
);
/* Callback */
struct wifi_msg_sme_disconnect_rsp_t{
uint16 result,
uint8 hw_interface
}
void wifi_rsp_sme_disconnect(
const struct wifi_msg_sme_disconnect_rsp_t * msg
)
BGScript Functions
call sme_disconnect()(result, hw_interface)
Bluegiga – A Silicon Labs Company
Page 44 of 236
Scan Results Sort RSSI--SME--Wi-Fi
This command can be used to resend scan results of a previous scan, sorted according to RSSI value. This
command can be run only after the command sme_start_scan has been issued at least once during the current
session.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x01
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x0D
method
Message ID
4
uint8
amount
Max number of wireless networks to list, closest on top
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x0D
method
Message ID
4-5
uint16
result
Return code
0 : success
non-zero : An error occurred
For error values refer to the error code documentation
Table: EVENTS
event
Description
sme_scan_sort_result
Sent for each network
sme_scan_sort_finished
Sent after operation completes
C Functions
/* Function */
void wifi_cmd_sme_scan_results_sort_rssi(
uint8 amount
);
/* Callback */
struct wifi_msg_sme_scan_results_sort_rssi_rsp_t{
uint16 result
}
void wifi_rsp_sme_scan_results_sort_rssi(
const struct wifi_msg_sme_scan_results_sort_rssi_rsp_t * msg
)
BGScript Functions
call sme_scan_results_sort_rssi(amount)(result)
Bluegiga – A Silicon Labs Company
Page 45 of 236
Set Password--SME--Wi-Fi
This command can be used to set the network password used when authenticating with an Access Point.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x01
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x05
method
Message ID
4
uint8array password WEP/WPA/WPA2 pre-shared password to be used when connecting to an
Access Point.
WPA/WPA2-PSK is either a hash of 64 hexadecimal characters, or a passphrase of 8 to 63 ASCII-encoded characters.
64-bit WEP key is either 5 ASCII-encoded characters or 10 HEX characters.
128-bit WEP key is either 13 ASCII-encoded characters or 26 HEX
characters.
Out of the two methods of authentication that can be used by WEP only the
Open System authentication is supported.
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x01
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x05
method
Message ID
4
uint8
status
Result code
0: success
128: invalid password
C Functions
/* Function */
void wifi_cmd_sme_set_password(
uint8 password_len,
const uint8* password_data
);
/* Callback */
struct wifi_msg_sme_set_password_rsp_t{
uint8 status
}
void wifi_rsp_sme_set_password(
const struct wifi_msg_sme_set_password_rsp_t * msg
)
BGScript Functions
call sme_set_password(password_len, password_data)(status)
Bluegiga – A Silicon Labs Company
Page 46 of 236
Connect SSID--SME--Wi-Fi
This command can be used to start a connection establishment procedure with an Access Point with the given
SSID. This command supports both visible and hidden SSIDs.
Executing this command will also launch a transparent scan procedure in order to discover the Access Points in
range, but the results of the scan procedure will not be exposed to the user. The channels used in the scan
procedure can be defined with the Set Scan Channels command. If the command has not been executed all
channels (1 to 13) will be scanned. If the Access Point is using channel 12 or 13, for the connection to be
successful, at least one of the Access Points found in range must advertise the use of channels up to 13.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x01
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x07
method
Message ID
4
uint8array
ssid
The SSID of the network to connect to
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x09
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x07
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
6
uint8
hw_interface
Hardware interface
0 : Wi-Fi
7 - 12
hw_addr
bssid
The BSSID of the access point that will be connected to
Table: EVENTS
event
Description
sme_connect_retry
Sent when a connection attempt fails and is automatically retried
sme_connected
Sent when connection succeeds
sme_connect_failed
Sent when connection fails
sme_interface_status
Sent after Wi-Fi interface is up
Bluegiga – A Silicon Labs Company
Page 47 of 236
C Functions
/* Function */
void wifi_cmd_sme_connect_ssid(
uint8 ssid_len,
const uint8* ssid_data
);
/* Callback */
struct wifi_msg_sme_connect_ssid_rsp_t{
uint16 result,
uint8 hw_interface,
hw_addr bssid
}
void wifi_rsp_sme_connect_ssid(
const struct wifi_msg_sme_connect_ssid_rsp_t * msg
)
BGScript Functions
call sme_connect_ssid(ssid_len, ssid_data)(result, hw_interface, bssid)
Bluegiga – A Silicon Labs Company
Page 48 of 236
Get Signal Quality
This command can be used to get a value indicating the signal quality of the connection.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x00
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x13
method
Message ID
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x03
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x13
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
6
uint8
hw_interface
Hardware interface
0 : Wi-Fi
Table: EVENTS
event
Description
sme_signal_quality
Connection signal quality
C Functions
/* Function */
void wifi_cmd_sme_get_signal_quality(
void
);
/* Callback */
struct wifi_msg_sme_get_signal_quality_rsp_t{
uint16 result,
uint8 hw_interface
}
void wifi_rsp_sme_get_signal_quality(
const struct wifi_msg_sme_get_signal_quality_rsp_t * msg
)
BGScript Functions
call sme_get_signal_quality()(result, hw_interface)
Bluegiga – A Silicon Labs Company
Page 49 of 236
Start WPS
This command can be used to start the Wi-Fi Protected Setup (WPS) session. Only WPS PUSH mode for the
Wi-Fi client side is available.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x00
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x11
method
Message ID
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x03
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x11
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
6
uint8
hw_interface
Hardware interface
0 : Wi-Fi
Table: EVENTS
event
Description
sme_wps_completed
Sent when WPS successfully completes
sme_wps_failed
Sent when WPS fails
sme_wps_credential_ssid
Received network name credential
sme_wps_credential_password
Received network password credential
C Functions
/* Function */
void wifi_cmd_sme_start_wps(
void
);
/* Callback */
struct wifi_msg_sme_start_wps_rsp_t{
uint16 result,
uint8 hw_interface
}
void wifi_rsp_sme_start_wps(
const struct wifi_msg_sme_start_wps_rsp_t * msg
)
Bluegiga – A Silicon Labs Company
Page 50 of 236
BGScript Functions
call sme_start_wps()(result, hw_interface)
Bluegiga – A Silicon Labs Company
Page 51 of 236
Stop WPS
This command can be used to stop the Wi-Fi Protected Setup (WPS) session.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x00
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x12
method
Message ID
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x03
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x12
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
6
uint8
hw_interface
Hardware interface
0 : Wi-Fi
Table: EVENTS
event
Description
sme_wps_stopped
Sent after WPS stopped
C Functions
/* Function */
void wifi_cmd_sme_stop_wps(
void
);
/* Callback */
struct wifi_msg_sme_stop_wps_rsp_t{
uint16 result,
uint8 hw_interface
}
void wifi_rsp_sme_stop_wps(
const struct wifi_msg_sme_stop_wps_rsp_t * msg
)
BGScript Functions
call sme_stop_wps()(result, hw_interface)
Bluegiga – A Silicon Labs Company
Page 52 of 236
Set Operating Mode--SME--Wi-Fi
This command can be used to set the Wi-Fi operating mode either to Wi-Fi client (STA) or Wi-Fi Access Point
(AP). The selected operating mode will become effective after the next time the radio is turned on by launching
the command sme_wifi_on.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x01
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x0A
method
Message ID
4
uint8
mode
1: Station (default)
2: Access Point
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x0A
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
C Functions
/* Function */
void wifi_cmd_sme_set_operating_mode(
uint8 mode
);
/* Callback */
struct wifi_msg_sme_set_operating_mode_rsp_t{
uint16 result
}
void wifi_rsp_sme_set_operating_mode(
const struct wifi_msg_sme_set_operating_mode_rsp_t * msg
)
BGScript Functions
call sme_set_operating_mode(mode)(result)
Bluegiga – A Silicon Labs Company
Page 53 of 236
Set AP Max Clients
This command can be used to set the maximum amount of stations that can be associated to the Access Point
at the same time.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x01
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x10
method
Message ID
4
uint8
max_clients
The maximum amount of allowed stations, from 0 to 5.
Default is 5.
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x03
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x10
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
6
uint8
hw_interface
Hardware interface
0 : Wi-Fi
C Functions
/* Function */
void wifi_cmd_sme_set_ap_max_clients(
uint8 max_clients
);
/* Callback */
struct wifi_msg_sme_set_ap_max_clients_rsp_t{
uint16 result,
uint8 hw_interface
}
void wifi_rsp_sme_set_ap_max_clients(
const struct wifi_msg_sme_set_ap_max_clients_rsp_t * msg
)
BGScript Functions
call sme_set_ap_max_clients(max_clients)(result, hw_interface)
Bluegiga – A Silicon Labs Company
Page 54 of 236
Set AP Password--SME--Wi-Fi
This command can be used to set the Wi-Fi password for an Access Point.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x01
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x0F
method
Message ID
4
uint8array password The password to be used for Access Point
WPA/WPA2-PSK is either a string of 64 hexadecimal characters or a
passphrase of 8 to 63 ASCII-encoded characters.
64-bit WEP key is either 5 ASCII-encoded characters or 10 HEX characters.
128-bit WEP key is either 13 ASCII-encoded characters or 26 HEX
characters.
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x01
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x0F
method
Message ID
4
uint8
status
Result code
0: success
128: invalid password
C Functions
/* Function */
void wifi_cmd_sme_set_ap_password(
uint8 password_len,
const uint8* password_data
);
/* Callback */
struct wifi_msg_sme_set_ap_password_rsp_t{
uint8 status
}
void wifi_rsp_sme_set_ap_password(
const struct wifi_msg_sme_set_ap_password_rsp_t * msg
)
BGScript Functions
call sme_set_ap_password(password_len, password_data)(status)
Bluegiga – A Silicon Labs Company
Page 55 of 236
Start AP Mode--SME--Wi-Fi
This command can be used to start the Wi-Fi Access Point mode.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x03
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x0B
method
Message ID
4
uint8
channel Channel to use. Possible channels are:
1...11 (default)
1...13 (only after a scan is performed beforehand and only if at least one
access point found in range is advertising channel use up to 13)
5
security Security mode to use.
uint8
0: Open security
1: WPA security
2: WPA2 security
3: WEP security
6
uint8array ssid
SSID of the network. Maximum length of the SSID is 32 characters.
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x03
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x0B
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
6
uint8
hw_interface
Hardware interface
0 : Wi-Fi
Table: EVENTS
event
Description
sme_ap_mode_started
Sent after AP mode successfully started
sme_ap_mode_failed
Sent after AP mode fails
sme_interface_status
Sent after Wi-Fi interface is up
Bluegiga – A Silicon Labs Company
Page 56 of 236
C Functions
/* Function */
void wifi_cmd_sme_start_ap_mode(
uint8 channel,
uint8 security,
uint8 ssid_len,
const uint8* ssid_data
);
/* Callback */
struct wifi_msg_sme_start_ap_mode_rsp_t{
uint16 result,
uint8 hw_interface
}
void wifi_rsp_sme_start_ap_mode(
const struct wifi_msg_sme_start_ap_mode_rsp_t * msg
)
BGScript Functions
call sme_start_ap_mode(channel, security, ssid_len, ssid_data)(result, hw_interface)
Bluegiga – A Silicon Labs Company
Page 57 of 236
Stop AP Mode--SME--Wi-Fi
This command can be used to stop the Wi-Fi Access Point mode.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x00
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x0C
method
Message ID
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x03
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x0C
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
6
uint8
hw_interface
Hardware interface
0 : Wi-Fi
Table: EVENTS
event
Description
sme_ap_mode_stopped
Sent after AP mode stopped
sme_interface_status
Sent after Wi-Fi interface is down
C Functions
/* Function */
void wifi_cmd_sme_stop_ap_mode(
void
);
/* Callback */
struct wifi_msg_sme_stop_ap_mode_rsp_t{
uint16 result,
uint8 hw_interface
}
void wifi_rsp_sme_stop_ap_mode(
const struct wifi_msg_sme_stop_ap_mode_rsp_t * msg
)
BGScript Functions
call sme_stop_ap_mode()(result, hw_interface)
Bluegiga – A Silicon Labs Company
Page 58 of 236
AP Client Disconnect--SME--Wi-Fi
This command can be used to disconnect a station from the network (from an Access Point).
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x06
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x0E
method
Message ID
4-9
hw_addr
mac_address
MAC address of the station
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x03
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x0E
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
6
uint8
hw_interface
Hardware interface
0 : Wi-Fi
Table: EVENTS
event
Description
sme_ap_client_left
Send when the station has been disconnected
C Functions
/* Function */
void wifi_cmd_sme_ap_client_disconnect(
hw_addr mac_address
);
/* Callback */
struct wifi_msg_sme_ap_client_disconnect_rsp_t{
uint16 result,
uint8 hw_interface
}
void wifi_rsp_sme_ap_client_disconnect(
const struct wifi_msg_sme_ap_client_disconnect_rsp_t * msg
)
BGScript Functions
call sme_ap_client_disconnect(mac_address)(result, hw_interface)
Bluegiga – A Silicon Labs Company
Page 59 of 236
Start SSID Scan--SME--Wi-Fi
This command can be used to initiate a scan for Access Points. Scanning is not possible once connected.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x01
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x1C
method
Message ID
4
uint8array
ssid
The SSID to scan for. Zero-length if all SSID's are to be scanned.
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x1C
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
Table: EVENTS
event
Description
sme_scan_result
Sent for each Access Point
sme_scan_result_drop
Sent for each dropped Access Point
sme_scanned
Sent after scan completes
C Functions
/* Function */
void wifi_cmd_sme_start_ssid_scan(
uint8 ssid_len,
const uint8* ssid_data
);
/* Callback */
struct wifi_msg_sme_start_ssid_scan_rsp_t{
uint16 result
}
void wifi_rsp_sme_start_ssid_scan(
const struct wifi_msg_sme_start_ssid_scan_rsp_t * msg
)
BGScript Functions
call sme_start_ssid_scan(ssid_len, ssid_data)(result)
Bluegiga – A Silicon Labs Company
Page 60 of 236
Set AP Hidden--SME--Wi-Fi
This command can be used to set whether the Access Point is hidden or visible. The Access Point is set visible
by default.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x01
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x1D
method
Message ID
4
uint8
hidden
Visibility
0 : visible
1 : hidden
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x03
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x1D
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
6
uint8
hw_interface
Hardware interface
0 : Wi-Fi
C Functions
/* Function */
void wifi_cmd_sme_set_ap_hidden(
uint8 hidden
);
/* Callback */
struct wifi_msg_sme_set_ap_hidden_rsp_t{
uint16 result,
uint8 hw_interface
}
void wifi_rsp_sme_set_ap_hidden(
const struct wifi_msg_sme_set_ap_hidden_rsp_t * msg
)
BGScript Functions
call sme_set_ap_hidden(hidden)(result, hw_interface)
Bluegiga – A Silicon Labs Company
Page 61 of 236
Set 11n Mode--SME--Wi-Fi
This command can be used to select whether 802.11n mode is enabled or disabled. The mode is enabled by
default.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x01
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x1E
method
Message ID
4
uint8
mode
802.11n mode
0 : disabled
1 : enabled
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x03
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x1E
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
6
uint8
hw_interface
Hardware interface
0 : Wi-Fi
C Functions
/* Function */
void wifi_cmd_sme_set_11n_mode(
uint8 mode
);
/* Callback */
struct wifi_msg_sme_set_11n_mode_rsp_t{
uint16 result,
uint8 hw_interface
}
void wifi_rsp_sme_set_11n_mode(
const struct wifi_msg_sme_set_11n_mode_rsp_t * msg
)
BGScript Functions
call sme_set_11n_mode(mode)(result, hw_interface)
Bluegiga – A Silicon Labs Company
Page 62 of 236
5.3.2 Events--SME--Wi-Fi
This events are related to Wi-Fi.
Wi-Fi is On--SME--Wi-Fi
This event indicates that the 802.11 radio is powered up and ready to receive commands.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x02
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x00
method
Message ID
4-5
uint16
result
Return code
0 : success
non-zero : An error occurred
For error values refer to the error code documentation
C Functions
/* Callback */
struct wifi_msg_sme_wifi_is_on_evt_t{
uint16 result
}
void wifi_evt_sme_wifi_is_on(
const struct wifi_msg_sme_wifi_is_on_evt_t * msg
)
BGScript Functions
event sme_wifi_is_on(result)
Bluegiga – A Silicon Labs Company
Page 63 of 236
Wi-Fi is Off--SME--Wi-Fi
This event indicates that the 802.11 radio has been powered off. This event can also indicate that the 802.11
radio had an internal error and was shut down, in which case the user application must re-initialize the radio by
turning it on.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x02
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x01
method
Message ID
4-5
uint16
result
Return code
0 : success
non-zero : An error occurred
For error values refer to the error code documentation
C Functions
/* Callback */
struct wifi_msg_sme_wifi_is_off_evt_t{
uint16 result
}
void wifi_evt_sme_wifi_is_off(
const struct wifi_msg_sme_wifi_is_off_evt_t * msg
)
BGScript Functions
event sme_wifi_is_off(result)
Bluegiga – A Silicon Labs Company
Page 64 of 236
Scan Result--SME--Wi-Fi
This event indicates Access Point scan results. After a scan has been started these events are sent every time
an Access Point is discovered. Access Point is also added to internal scan list and it is possible to connect to it.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x0C
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x02
method
Message ID
4-9
hw_addr
bssid
The BSSID of an Access Point which was found
10
int8
channel The channel on which an Access Point was seen
11 12
int16
rssi
The received signal strength indication of the found Access Point, in dBm.
The RSSI values are reported in 1dBm steps.
This event is triggered only if the RSSI value corresponds to -88dBm or
above.
13
int8
snr
The signal to noise ratio of an Access Point. The values are reported in 1dB
steps.
14
uint8
secure
Access Point security status as a bitmask.
bit 0: whether the AP supports secure connections
bit 1: whether the AP supports WPS
15
uint8array ssid
The SSID of the network the Access Point belongs to
C Functions
/* Callback */
struct wifi_msg_sme_scan_result_evt_t{
hw_addr bssid,
int8 channel,
int16 rssi,
int8 snr,
uint8 secure,
uint8 ssid_len,
const uint8* ssid_data
}
void wifi_evt_sme_scan_result(
const struct wifi_msg_sme_scan_result_evt_t * msg
)
BGScript Functions
event sme_scan_result(bssid, channel, rssi, snr, secure, ssid_len, ssid_data)
Bluegiga – A Silicon Labs Company
Page 65 of 236
Scan Result Drop--SME--Wi-Fi
This event indicates that the Access Point was dropped from the internal scan list. It is not possible to connect
to it anymore.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x06
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x03
method
Message ID
4-9
hw_addr
bssid
The BSSID of the Access Point that was dropped
C Functions
/* Callback */
struct wifi_msg_sme_scan_result_drop_evt_t{
hw_addr bssid
}
void wifi_evt_sme_scan_result_drop(
const struct wifi_msg_sme_scan_result_drop_evt_t * msg
)
BGScript Functions
event sme_scan_result_drop(bssid)
Bluegiga – A Silicon Labs Company
Page 66 of 236
Scanned--SME--Wi-Fi
This event indicates the Access Point scan is finished.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x01
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x04
method
Message ID
4
int8
status
Scan status
0 : scan finished normally
C Functions
/* Callback */
struct wifi_msg_sme_scanned_evt_t{
int8 status
}
void wifi_evt_sme_scanned(
const struct wifi_msg_sme_scanned_evt_t * msg
)
BGScript Functions
event sme_scanned(status)
Bluegiga – A Silicon Labs Company
Page 67 of 236
Scan Sort Result--SME--Wi-Fi
This event indicates the scan result.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x0C
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x0F
method
Message ID
4-9
hw_addr
bssid
The BSSID of the Access Point which was found
10
int8
channel
The channel on which the Access Point was seen
11 - 12
int16
rssi
The received signal strength indication of the found Access Point.
The values are reported in 1dBm steps.
13
int8
snr
The signal to noise ratio of the Access Point.
The values are reported in 1dB steps.
14
uint8
secure
Access Point security status as a bitmask.
bit 0: whether the AP supports secure connections
bit 1: whether the AP supports WPS
15
uint8array
ssid
The SSID of the network the Access Point belongs to.
C Functions
/* Callback */
struct wifi_msg_sme_scan_sort_result_evt_t{
hw_addr bssid,
int8 channel,
int16 rssi,
int8 snr,
uint8 secure,
uint8 ssid_len,
const uint8* ssid_data
}
void wifi_evt_sme_scan_sort_result(
const struct wifi_msg_sme_scan_sort_result_evt_t * msg
)
BGScript Functions
event sme_scan_sort_result(bssid, channel, rssi, snr, secure, ssid_len, ssid_data)
Bluegiga – A Silicon Labs Company
Page 68 of 236
Scan Sort Finished--SME--Wi-Fi
This event indicates that the scan result sort is finished.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x00
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x10
method
Message ID
C Functions
/* Callback */
void wifi_evt_sme_scan_sort_finished(
const void *nul
)
BGScript Functions
event sme_scan_sort_finished()
Bluegiga – A Silicon Labs Company
Page 69 of 236
Connected--SME--Wi-Fi
This event indicates a successful connection to an Access Point.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x08
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x05
method
Message ID
4
int8
status
Wi-Fi connection status
0: Wi-Fi is connected
1: Wi-Fi is not connected
5
uint8
hw_interface
Hardware interface
0 : Wi-Fi
6 - 11
hw_addr
bssid
The BSSID of the device that the module connected to
C Functions
/* Callback */
struct wifi_msg_sme_connected_evt_t{
int8 status,
uint8 hw_interface,
hw_addr bssid
}
void wifi_evt_sme_connected(
const struct wifi_msg_sme_connected_evt_t * msg
)
BGScript Functions
event sme_connected(status, hw_interface, bssid)
Bluegiga – A Silicon Labs Company
Page 70 of 236
Connect Retry--SME--Wi-Fi
This event indicates that a connection attempt failed, which will eventually lead to an automatic retry. This event
appears typically when the module is commanded to connect to a wireless network but the given password is
wrong. The amount of retries is fixed to 10 and the retries can be stopped with the command
wifi_cmd_sme_disconnect.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x01
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x09
method
Message ID
4
uint8
hw_interface
Hardware interface
0 : Wi-Fi
C Functions
/* Callback */
struct wifi_msg_sme_connect_retry_evt_t{
uint8 hw_interface
}
void wifi_evt_sme_connect_retry(
const struct wifi_msg_sme_connect_retry_evt_t * msg
)
BGScript Functions
event sme_connect_retry(hw_interface)
Bluegiga – A Silicon Labs Company
Page 71 of 236
Connect Failed--SME--Wi-Fi
This event indicates a failed connection to an Access Point. This event may occur if the device is unable to
establish a connection to an Access Point or if the Access Point disconnects the device during the connection.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x03
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x08
method
Message ID
4-5
uint16
reason
Failure reason
For values refer to the error code documentation
6
uint8
hw_interface
Hardware interface
0 : Wi-Fi
C Functions
/* Callback */
struct wifi_msg_sme_connect_failed_evt_t{
uint16 reason,
uint8 hw_interface
}
void wifi_evt_sme_connect_failed(
const struct wifi_msg_sme_connect_failed_evt_t * msg
)
BGScript Functions
event sme_connect_failed(reason, hw_interface)
Bluegiga – A Silicon Labs Company
Page 72 of 236
Disconnected--SME--Wi-Fi
This event indicates a disconnection from an Access Point. The event occurs either because sme_disconnect
command was issued or connection to an Access Point was lost. Connection loss could occur because the
Access Point has been switched off or the user has moved out of coverage. The timeout for detecting a lost
connection is 50 beacons which under typical network configuration translates to roughly 5 seconds.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x03
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x06
method
Message ID
4-5
uint16
reason
Disconnect reason
For values refer to the error code documentation
6
uint8
hw_interface
Hardware interface
0 : Wi-Fi
C Functions
/* Callback */
struct wifi_msg_sme_disconnected_evt_t{
uint16 reason,
uint8 hw_interface
}
void wifi_evt_sme_disconnected(
const struct wifi_msg_sme_disconnected_evt_t * msg
)
BGScript Functions
event sme_disconnected(reason, hw_interface)
Bluegiga – A Silicon Labs Company
Page 73 of 236
WPS Credential SSID
This event indicates the SSID of the network in relation to Wi-Fi Protected Setup (WPS).
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x02
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x14
method
Message ID
4
uint8
hw_interface
Hardware interface
0 : Wi-Fi
5
uint8array
ssid
SSID of the network
C Functions
/* Callback */
struct wifi_msg_sme_wps_credential_ssid_evt_t{
uint8 hw_interface,
uint8 ssid_len,
const uint8* ssid_data
}
void wifi_evt_sme_wps_credential_ssid(
const struct wifi_msg_sme_wps_credential_ssid_evt_t * msg
)
BGScript Functions
event sme_wps_credential_ssid(hw_interface, ssid_len, ssid_data)
Bluegiga – A Silicon Labs Company
Page 74 of 236
WPS Credential Password
This event indicates the password of then network in relation to Wi-Fi Protected Setup (WPS).
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x02
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x15
method
Message ID
4
uint8
hw_interface Hardware interface
0 : Wi-Fi
5
uint8array password
Password of the network.
WPA/WPA2-PSK is either a string of 64 hexadecimal characters or a
passphrase of 8 to 63 ASCII-encoded characters.
64-bit WEP key is either 5 ASCII-encoded characters or 10 HEX
characters.
128-bit WEP key is either 13 ASCII-encoded characters or 26 HEX
characters.
C Functions
/* Callback */
struct wifi_msg_sme_wps_credential_password_evt_t{
uint8 hw_interface,
uint8 password_len,
const uint8* password_data
}
void wifi_evt_sme_wps_credential_password(
const struct wifi_msg_sme_wps_credential_password_evt_t * msg
)
BGScript Functions
event sme_wps_credential_password(hw_interface, password_len, password_data)
Bluegiga – A Silicon Labs Company
Page 75 of 236
WPS Completed
This event indicates that the Wi-Fi Protected Setup (WPS) session was completed successfully.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x01
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x12
method
Message ID
4
uint8
hw_interface
Hardware interface
0 : Wi-Fi
C Functions
/* Callback */
struct wifi_msg_sme_wps_completed_evt_t{
uint8 hw_interface
}
void wifi_evt_sme_wps_completed(
const struct wifi_msg_sme_wps_completed_evt_t * msg
)
BGScript Functions
event sme_wps_completed(hw_interface)
Bluegiga – A Silicon Labs Company
Page 76 of 236
WPS Failed
This event indicates that the Wi-Fi Protected Setup (WPS) session failed.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x03
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x13
method
Message ID
4-5
uint16
reason
Failure reason
For values refer to the error code documentation
6
uint8
hw_interface
Hardware interface
0 : Wi-Fi
C Functions
/* Callback */
struct wifi_msg_sme_wps_failed_evt_t{
uint16 reason,
uint8 hw_interface
}
void wifi_evt_sme_wps_failed(
const struct wifi_msg_sme_wps_failed_evt_t * msg
)
BGScript Functions
event sme_wps_failed(reason, hw_interface)
Bluegiga – A Silicon Labs Company
Page 77 of 236
WPS Stopped
This event indicates that the Wi-Fi Protected Setup (WPS) session was stopped.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x01
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x11
method
Message ID
4
uint8
hw_interface
Hardware interface
0 : Wi-Fi
C Functions
/* Callback */
struct wifi_msg_sme_wps_stopped_evt_t{
uint8 hw_interface
}
void wifi_evt_sme_wps_stopped(
const struct wifi_msg_sme_wps_stopped_evt_t * msg
)
BGScript Functions
event sme_wps_stopped(hw_interface)
Bluegiga – A Silicon Labs Company
Page 78 of 236
Signal Quality
This event indicates the signal quality (RSSI value) of the connection in dBm units.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x02
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x16
method
Message ID
4
int8
rssi
The received signal strength indication (RSSI) in dBm units.
5
uint8
hw_interface
Hardware interface
0 : Wi-Fi
C Functions
/* Callback */
struct wifi_msg_sme_signal_quality_evt_t{
int8 rssi,
uint8 hw_interface
}
void wifi_evt_sme_signal_quality(
const struct wifi_msg_sme_signal_quality_evt_t * msg
)
BGScript Functions
event sme_signal_quality(rssi, hw_interface)
Bluegiga – A Silicon Labs Company
Page 79 of 236
AP Mode Started--SME--Wi-Fi
This event indicates that the Wi-Fi Access Point mode has been successfully started.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x01
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x0A
method
Message ID
4
uint8
hw_interface
Hardware interface
0 : Wi-Fi
C Functions
/* Callback */
struct wifi_msg_sme_ap_mode_started_evt_t{
uint8 hw_interface
}
void wifi_evt_sme_ap_mode_started(
const struct wifi_msg_sme_ap_mode_started_evt_t * msg
)
BGScript Functions
event sme_ap_mode_started(hw_interface)
Bluegiga – A Silicon Labs Company
Page 80 of 236
AP Mode Stopped--SME--Wi-Fi
This event indicates that the Wi-Fi Access Point mode has been stopped.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x01
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x0B
method
Message ID
4
uint8
hw_interface
Hardware interface
0 : Wi-Fi
C Functions
/* Callback */
struct wifi_msg_sme_ap_mode_stopped_evt_t{
uint8 hw_interface
}
void wifi_evt_sme_ap_mode_stopped(
const struct wifi_msg_sme_ap_mode_stopped_evt_t * msg
)
BGScript Functions
event sme_ap_mode_stopped(hw_interface)
Bluegiga – A Silicon Labs Company
Page 81 of 236
AP Mode Failed--SME--Wi-Fi
This event indicates that the Wi-Fi Access Point mode has failed.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x03
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x0C
method
Message ID
4-5
uint16
reason
Failure reason
For values refer to the error code documentation
6
uint8
hw_interface
Hardware interface
0 : Wi-Fi
C Functions
/* Callback */
struct wifi_msg_sme_ap_mode_failed_evt_t{
uint16 reason,
uint8 hw_interface
}
void wifi_evt_sme_ap_mode_failed(
const struct wifi_msg_sme_ap_mode_failed_evt_t * msg
)
BGScript Functions
event sme_ap_mode_failed(reason, hw_interface)
Bluegiga – A Silicon Labs Company
Page 82 of 236
AP Client Joined--SME--Wi-Fi
This event indicates that a Wi-Fi client has joined the network.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x07
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x0D
method
Message ID
4-9
hw_addr
mac_address
MAC address of the station
10
uint8
hw_interface
Hardware interface
0 : Wi-Fi
C Functions
/* Callback */
struct wifi_msg_sme_ap_client_joined_evt_t{
hw_addr mac_address,
uint8 hw_interface
}
void wifi_evt_sme_ap_client_joined(
const struct wifi_msg_sme_ap_client_joined_evt_t * msg
)
BGScript Functions
event sme_ap_client_joined(mac_address, hw_interface)
Bluegiga – A Silicon Labs Company
Page 83 of 236
AP Client Left--SME--Wi-Fi
This event indicates that a Wi-Fi client (client), has left the Access Point.
In case a station moves out of range or is abruptly powered off, it might take from 180 to 270 seconds for this
event to be issued at the module operating as the Access Point. This timeout range is due to the fact that the
remote station is not sending any message to indicate that it is going to disconnect, while at the module side the
conditions to declare that a client has left are the following: considering slots of 90 seconds from the moment
the client connected, if in one slot there has been no message from the client, then the next slot is used to send
empty frames to the client (at the interval of 15 seconds) and if there is still no response from the client then the
connection is considered down, at which time this event is generated.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x07
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x0E
method
Message ID
4-9
hw_addr
mac_address
MAC address of the station
10
uint8
hw_interface
Hardware interface
0 : Wi-Fi
C Functions
/* Callback */
struct wifi_msg_sme_ap_client_left_evt_t{
hw_addr mac_address,
uint8 hw_interface
}
void wifi_evt_sme_ap_client_left(
const struct wifi_msg_sme_ap_client_left_evt_t * msg
)
BGScript Functions
event sme_ap_client_left(mac_address, hw_interface)
Bluegiga – A Silicon Labs Company
Page 84 of 236
Interface Status--SME--Wi-Fi
This event indicates the current network status. If for example DHCP has successfully finished and the module
has an IP address, it will send this event with status = 1.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x02
lolen
Minimum payload length
2
0x03
class
Message class: Wi-Fi
3
0x07
method
Message ID
4
uint8
hw_interface
Hardware interface
0 : Wi-Fi
5
uint8
status
Network status
0 : network down
1 : network up
C Functions
/* Callback */
struct wifi_msg_sme_interface_status_evt_t{
uint8 hw_interface,
uint8 status
}
void wifi_evt_sme_interface_status(
const struct wifi_msg_sme_interface_status_evt_t * msg
)
BGScript Functions
event sme_interface_status(hw_interface, status)
Bluegiga – A Silicon Labs Company
Page 85 of 236
5.4 TCP stack--Wi-Fi
This class contains commands related to TCP/IP stack and various protocols such as TCP and UDP and IP
address setup.
5.4.1 Commands--TCP/IP--Wi-Fi
These commands are related to the TCP stack.
Configure--TCP/IP--Wi-Fi
This command can be used to configure TCP/IP settings.
When using static IP addresses, this command can be used to configure the local IP address, netmask and
gateway.
When enabling a DHCP Client the settings for the static IP will be stored, but they will be overridden as soon as
the remote DHCP Server will assign its IP configuration to the module.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x0D
lolen
Minimum payload length
2
0x04
class
Message class: TCP stack
3
0x04
method
Message ID
4-7
ipv4
address
The local IP address of the device.
811
ipv4
netmask
The netmask of the device.
12 15
ipv4
gateway
The gateway used by the device when in station (client) mode.
In access point mode this is not relevant, because the local DHCP server will
automatically use the local IP address above as the gateway to pass to remote
clients.
16
uint8
use_dhcp Use DHCP
0 : Use static IP settings
1 : DHCP Client is used to obtain the dynamic IP configuration
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x04
class
Message class: TCP stack
3
0x04
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
Bluegiga – A Silicon Labs Company
Page 86 of 236
Table: EVENTS
event
Description
tcpip_configuration
Sent when TCP/IP configuration changes
C Functions
/* Function */
void wifi_cmd_tcpip_configure(
ipv4 address,
ipv4 netmask,
ipv4 gateway,
uint8 use_dhcp
);
/* Callback */
struct wifi_msg_tcpip_configure_rsp_t{
uint16 result
}
void wifi_rsp_tcpip_configure(
const struct wifi_msg_tcpip_configure_rsp_t * msg
)
BGScript Functions
call tcpip_configure(address, netmask, gateway, use_dhcp)(result)
Bluegiga – A Silicon Labs Company
Page 87 of 236
DHCP Set Hostname--TCP/IP--Wi-Fi
This command can be used to set the DHCP host name parameter (option 12) used in client DHCPDISCOVER
and DHCPREQUEST messages.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x01
lolen
Minimum payload length
2
0x04
class
Message class: TCP stack
3
0x08
method
Message ID
4
uint8array
hostname
Host name
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x04
class
Message class: TCP stack
3
0x08
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
C Functions
/* Function */
void wifi_cmd_tcpip_dhcp_set_hostname(
uint8 hostname_len,
const uint8* hostname_data
);
/* Callback */
struct wifi_msg_tcpip_dhcp_set_hostname_rsp_t{
uint16 result
}
void wifi_rsp_tcpip_dhcp_set_hostname(
const struct wifi_msg_tcpip_dhcp_set_hostname_rsp_t * msg
)
BGScript Functions
call tcpip_dhcp_set_hostname(hostname_len, hostname_data)(result)
Bluegiga – A Silicon Labs Company
Page 88 of 236
DNS Configure--TCP/IP--Wi-Fi
This command can be used to configure DNS client settings.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x05
lolen
Minimum payload length
2
0x04
class
Message class: TCP stack
3
0x05
method
Message ID
4
uint8
index
Two different DNS servers can be stored. Index indicates which of the two this is.
0 : primary DNS server
1 : secondary DNS server
5-8
ipv4
address
The IP address of the DNS server
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x04
class
Message class: TCP stack
3
0x05
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
Table: EVENTS
event
Description
tcpip_dns_configuration
Sent when DNS configuration changes
C Functions
/* Function */
void wifi_cmd_tcpip_dns_configure(
uint8 index,
ipv4 address
);
/* Callback */
struct wifi_msg_tcpip_dns_configure_rsp_t{
uint16 result
}
void wifi_rsp_tcpip_dns_configure(
const struct wifi_msg_tcpip_dns_configure_rsp_t * msg
)
BGScript Functions
call tcpip_dns_configure(index, address)(result)
Bluegiga – A Silicon Labs Company
Page 89 of 236
DNS Gethostbyname--TCP/IP--Wi-Fi
This command can be used to start a procedure to resolve the hostname related to an IP address using the
configured DNS servers.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x01
lolen
Minimum payload length
2
0x04
class
Message class: TCP stack
3
0x06
method
Message ID
4
uint8array name
The name of the server whose IP address should be resolved, for example
www.bluegiga.com.
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x04
class
Message class: TCP stack
3
0x06
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
Table: EVENTS
event
Description
tcpip_dns_gethostbyname_result
Sent when DNS resolver query completes
C Functions
/* Function */
void wifi_cmd_tcpip_dns_gethostbyname(
uint8 name_len,
const uint8* name_data
);
/* Callback */
struct wifi_msg_tcpip_dns_gethostbyname_rsp_t{
uint16 result
}
void wifi_rsp_tcpip_dns_gethostbyname(
const struct wifi_msg_tcpip_dns_gethostbyname_rsp_t * msg
)
BGScript Functions
call tcpip_dns_gethostbyname(name_len, name_data)(result)
Bluegiga – A Silicon Labs Company
Page 90 of 236
TCP Connect--TCP/IP--Wi-Fi
This command can be used to attempt the creation of a new TCP socket to a TCP server.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x07
lolen
Minimum payload length
2
0x04
class
Message class: TCP stack
3
0x01
method
Message ID
4-7
ipv4
address The IP address of the remote server to which the module should connect.
8-9
uint16 port
The TCP port on the remote server
10
int8
The endpoint where the incoming data from the TCP server should be routed to.
-1 : data received is not automatically routed to other endpoint, but received as
endpoint_data event.
routing
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x03
lolen
Minimum payload length
2
0x04
class
Message class: TCP stack
3
0x01
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
6
uint8
endpoint
The endpoint id of the newly created TCP connection
Table: EVENTS
event
Description
tcpip_endpoint_status
Sent when TCP/IP endpoint status changes
endpoint_status
Sent when endpoint status changes
Bluegiga – A Silicon Labs Company
Page 91 of 236
C Functions
/* Function */
void wifi_cmd_tcpip_tcp_connect(
ipv4 address,
uint16 port,
int8 routing
);
/* Callback */
struct wifi_msg_tcpip_tcp_connect_rsp_t{
uint16 result,
uint8 endpoint
}
void wifi_rsp_tcpip_tcp_connect(
const struct wifi_msg_tcpip_tcp_connect_rsp_t * msg
)
BGScript Functions
call tcpip_tcp_connect(address, port, routing)(result, endpoint)
Bluegiga – A Silicon Labs Company
Page 92 of 236
Start TCP Server--TCP/IP--Wi-Fi
This command can be used to start a TCP server.
Once the TCP server is started, and a remote client establishes a new connection, the data coming from this
client will be routed by default to the endpoint specified in the default_destination parameter. If such endpoint,
say the UART interface, is configured to communicate with host via the BGAPI, then data will be carried via the
endpoint_data event, otherwise raw data is sent out of the specified interface. When -1 is used, data received
from the client is passed to BGScript via endpoint_data event, and/or endpoint_data event containing the data
is sent out of the interfaces over which BGAPI is enabled.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x03
lolen
Minimum payload length
2
0x04
class
Message class: TCP stack
3
0x00
method
Message ID
4-5
uint16 port
6
int8
The local port which to listen on.
default_destination Endpoint where data from connected client will be routed to. Use -1 to
generate endpoint_data events instead.
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x03
lolen
Minimum payload length
2
0x04
class
Message class: TCP stack
3
0x00
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
6
uint8
endpoint
The number of the endpoint the newly created TCP server uses
Table: EVENTS
event
Description
tcpip_endpoint_status
Sent when TCP/IP endpoint status changes
endpoint_status
Sent when endpoint status changes
Bluegiga – A Silicon Labs Company
Page 93 of 236
C Functions
/* Function */
void wifi_cmd_tcpip_start_tcp_server(
uint16 port,
int8 default_destination
);
/* Callback */
struct wifi_msg_tcpip_start_tcp_server_rsp_t{
uint16 result,
uint8 endpoint
}
void wifi_rsp_tcpip_start_tcp_server(
const struct wifi_msg_tcpip_start_tcp_server_rsp_t * msg
)
BGScript Functions
call tcpip_start_tcp_server(port, default_destination)(result, endpoint)
Bluegiga – A Silicon Labs Company
Page 94 of 236
UDP Connect--TCP/IP--Wi-Fi
This command can be used to attempt the creation of a new UDP connection.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x07
lolen
Minimum payload length
2
0x04
class
Message class: TCP stack
3
0x03
method
Message ID
4-7
ipv4
address The IP address of the remote server to which the packets should be sent
8-9
uint16 port
The UDP port of the remote server
10
int8
The endpoint index where the data from this connection should be routed to.
Notice that in the current firmwares there cannot be data coming from the endpoint
assigned to this UDP connection, due to the connectionless nature of the UDP
protocol. So, any index can be used here and no practical effect should be
expected.
routing
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x03
lolen
Minimum payload length
2
0x04
class
Message class: TCP stack
3
0x03
method
Message ID
4-5
uint16 result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
6
uint8
endpoint The endpoint index assigned to the newly created UDP connection. Use this
index for example to send data to the remote UDP server using the command
endpoint_send
Table: EVENTS
event
Description
tcpip_endpoint_status
Sent when TCP/IP endpoint status changes
endpoint_status
Sent when endpoint status changes
Bluegiga – A Silicon Labs Company
Page 95 of 236
C Functions
/* Function */
void wifi_cmd_tcpip_udp_connect(
ipv4 address,
uint16 port,
int8 routing
);
/* Callback */
struct wifi_msg_tcpip_udp_connect_rsp_t{
uint16 result,
uint8 endpoint
}
void wifi_rsp_tcpip_udp_connect(
const struct wifi_msg_tcpip_udp_connect_rsp_t * msg
)
BGScript Functions
call tcpip_udp_connect(address, port, routing)(result, endpoint)
Bluegiga – A Silicon Labs Company
Page 96 of 236
UDP Bind
In case an UDP endpoint exists and following the command tcpip_udp_connect, this command can be used to
change the currently used local source port (which is pseudo-randomly generated by the firmware) to a desired
specific source port.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x03
lolen
Minimum payload length
2
0x04
class
Message class: TCP stack
3
0x07
method
Message ID
4
uint8
endpoint
The endpoint which source port to change
5-6
uint16
port
The UDP port of source
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x04
class
Message class: TCP stack
3
0x07
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
C Functions
/* Function */
void wifi_cmd_tcpip_udp_bind(
uint8 endpoint,
uint16 port
);
/* Callback */
struct wifi_msg_tcpip_udp_bind_rsp_t{
uint16 result
}
void wifi_rsp_tcpip_udp_bind(
const struct wifi_msg_tcpip_udp_bind_rsp_t * msg
)
BGScript Functions
call tcpip_udp_bind(endpoint, port)(result)
Bluegiga – A Silicon Labs Company
Page 97 of 236
Start UDP Server--TCP/IP--Wi-Fi
This command can be used to start an UDP server.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x03
lolen
Minimum payload length
2
0x04
class
Message class: TCP stack
3
0x02
method
Message ID
4-5
uint16 port
6
int8
the local UDP port that the server listens on
default_destination The endpoint to which incoming UDP packets should be written.
-1 for destination means incoming data is notified with Udp Data event
which is the event carrying in addition the source IP address and port.
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x03
lolen
Minimum payload length
2
0x04
class
Message class: TCP stack
3
0x02
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
6
uint8
endpoint
The endpoint number of the newly created UDP server
Table: EVENTS
event
Description
tcpip_endpoint_status
Sent when TCP/IP endpoint status changes
endpoint_status
Sent when endpoint status changes
C Functions
/* Function */
void wifi_cmd_tcpip_start_udp_server(
uint16 port,
int8 default_destination
);
/* Callback */
struct wifi_msg_tcpip_start_udp_server_rsp_t{
uint16 result,
uint8 endpoint
}
void wifi_rsp_tcpip_start_udp_server(
const struct wifi_msg_tcpip_start_udp_server_rsp_t * msg
)
Bluegiga – A Silicon Labs Company
Page 98 of 236
BGScript Functions
call tcpip_start_udp_server(port, default_destination)(result, endpoint)
Bluegiga – A Silicon Labs Company
Page 99 of 236
DHCP Enable Routing--TCP/IP--Wi-Fi
This command can be used to enable or disable gateway and DNS router options in DHCP server offer and
ack. Options are enabled by default.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x01
lolen
Minimum payload length
2
0x04
class
Message class: TCP stack
3
0x0B
method
Message ID
4
uint8
enable
Routing options
0 : disabled
1 : enabled
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x04
class
Message class: TCP stack
3
0x0B
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
C Functions
/* Function */
void wifi_cmd_tcpip_dhcp_enable_routing(
uint8 enable
);
/* Callback */
struct wifi_msg_tcpip_dhcp_enable_routing_rsp_t{
uint16 result
}
void wifi_rsp_tcpip_dhcp_enable_routing(
const struct wifi_msg_tcpip_dhcp_enable_routing_rsp_t * msg
)
BGScript Functions
call tcpip_dhcp_enable_routing(enable)(result)
Bluegiga – A Silicon Labs Company
Page 100 of 236
mDNS Set Hostname--TCP/IP--Wi-Fi
This command can be used to set the mDNS hostname. mDNS service cannot be started until the hostname is
set. The maximum length of hostname is 63 bytes.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x01
lolen
Minimum payload length
2
0x04
class
Message class: TCP stack
3
0x0C
method
Message ID
4
uint8array hostname Multicast DNS hostname. The top-level domain .local is added
automatically.
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x04
class
Message class: TCP stack
3
0x0C
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
C Functions
/* Function */
void wifi_cmd_tcpip_mdns_set_hostname(
uint8 hostname_len,
const uint8* hostname_data
);
/* Callback */
struct wifi_msg_tcpip_mdns_set_hostname_rsp_t{
uint16 result
}
void wifi_rsp_tcpip_mdns_set_hostname(
const struct wifi_msg_tcpip_mdns_set_hostname_rsp_t * msg
)
BGScript Functions
call tcpip_mdns_set_hostname(hostname_len, hostname_data)(result)
Bluegiga – A Silicon Labs Company
Page 101 of 236
mDNS Start--TCP/IP--Wi-Fi
This command can be used to start the mDNS service.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x00
lolen
Minimum payload length
2
0x04
class
Message class: TCP stack
3
0x0D
method
Message ID
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x04
class
Message class: TCP stack
3
0x0D
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
Table: EVENTS
event
Description
tcpip_mdns_started
Sent when mDNS service is successfully started
tcpip_mdns_failed
Sent when mDNS service startup fails
C Functions
/* Function */
void wifi_cmd_tcpip_mdns_start(
void
);
/* Callback */
struct wifi_msg_tcpip_mdns_start_rsp_t{
uint16 result
}
void wifi_rsp_tcpip_mdns_start(
const struct wifi_msg_tcpip_mdns_start_rsp_t * msg
)
BGScript Functions
call tcpip_mdns_start()(result)
Bluegiga – A Silicon Labs Company
Page 102 of 236
mDNS Stop--TCP/IP--Wi-Fi
This command can be used to stop a mDNS service.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x00
lolen
Minimum payload length
2
0x04
class
Message class: TCP stack
3
0x0E
method
Message ID
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x04
class
Message class: TCP stack
3
0x0E
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
C Functions
/* Function */
void wifi_cmd_tcpip_mdns_stop(
void
);
/* Callback */
struct wifi_msg_tcpip_mdns_stop_rsp_t{
uint16 result
}
void wifi_rsp_tcpip_mdns_stop(
const struct wifi_msg_tcpip_mdns_stop_rsp_t * msg
)
BGScript Functions
call tcpip_mdns_stop()(result)
Bluegiga – A Silicon Labs Company
Page 103 of 236
DNS-SD Add Service--TCP/IP--Wi-Fi
This command can be used to add a new DNS-SD service. The maximum length of the service name is 15
bytes.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x04
lolen
Minimum payload length
2
0x04
class
Message class: TCP stack
3
0x0F
method
Message ID
4-5
uint16
port
Service port
6
uint8
protocol
Service protocol
0 : TCP
1 : UDP
7
uint8array
service
Service name
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x03
lolen
Minimum payload length
2
0x04
class
Message class: TCP stack
3
0x0F
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
6
uint8
index
Service index
C Functions
/* Function */
void wifi_cmd_tcpip_dnssd_add_service(
uint16 port,
uint8 protocol,
uint8 service_len,
const uint8* service_data
);
/* Callback */
struct wifi_msg_tcpip_dnssd_add_service_rsp_t{
uint16 result,
uint8 index
}
void wifi_rsp_tcpip_dnssd_add_service(
const struct wifi_msg_tcpip_dnssd_add_service_rsp_t * msg
)
Bluegiga – A Silicon Labs Company
Page 104 of 236
BGScript Functions
call tcpip_dnssd_add_service(port, protocol, service_len, service_data)(result, index)
Bluegiga – A Silicon Labs Company
Page 105 of 236
DNS-SD Add Service Instance--TCP/IP--Wi-Fi
This command can be used to add a DNS-SD service instance name. The maximum length of the service
instance name is 63 bytes. The DNS-SD service cannot be started until the instance name is set.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x04
class
Message class: TCP stack
3
0x10
method
Message ID
4
uint8
index
Service index
5
uint8array
instance
Service instance name
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x04
class
Message class: TCP stack
3
0x10
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
C Functions
/* Function */
void wifi_cmd_tcpip_dnssd_add_service_instance(
uint8 index,
uint8 instance_len,
const uint8* instance_data
);
/* Callback */
struct wifi_msg_tcpip_dnssd_add_service_instance_rsp_t{
uint16 result
}
void wifi_rsp_tcpip_dnssd_add_service_instance(
const struct wifi_msg_tcpip_dnssd_add_service_instance_rsp_t * msg
)
BGScript Functions
call tcpip_dnssd_add_service_instance(index, instance_len, instance_data)(result)
Bluegiga – A Silicon Labs Company
Page 106 of 236
DNS-SD Add Service Attribute--TCP/IP--Wi-Fi
This command can be used to add a DNS-SD service attribute. The maximum length of the service attribute is
63 bytes.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x04
class
Message class: TCP stack
3
0x11
method
Message ID
4
uint8
index
Service index
5
uint8array
attribute
Service attribute
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x04
class
Message class: TCP stack
3
0x11
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
C Functions
/* Function */
void wifi_cmd_tcpip_dnssd_add_service_attribute(
uint8 index,
uint8 attribute_len,
const uint8* attribute_data
);
/* Callback */
struct wifi_msg_tcpip_dnssd_add_service_attribute_rsp_t{
uint16 result
}
void wifi_rsp_tcpip_dnssd_add_service_attribute(
const struct wifi_msg_tcpip_dnssd_add_service_attribute_rsp_t * msg
)
BGScript Functions
call tcpip_dnssd_add_service_attribute(index, attribute_len, attribute_data)(result)
Bluegiga – A Silicon Labs Company
Page 107 of 236
DNS-SD Remove Service--TCP/IP--Wi-Fi
This command can be used to remove a DNS-SD service.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x01
lolen
Minimum payload length
2
0x04
class
Message class: TCP stack
3
0x12
method
Message ID
4
uint8
index
Service index
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x04
class
Message class: TCP stack
3
0x12
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
C Functions
/* Function */
void wifi_cmd_tcpip_dnssd_remove_service(
uint8 index
);
/* Callback */
struct wifi_msg_tcpip_dnssd_remove_service_rsp_t{
uint16 result
}
void wifi_rsp_tcpip_dnssd_remove_service(
const struct wifi_msg_tcpip_dnssd_remove_service_rsp_t * msg
)
BGScript Functions
call tcpip_dnssd_remove_service(index)(result)
Bluegiga – A Silicon Labs Company
Page 108 of 236
DNS-SD Start Service--TCP/IP--Wi-Fi
This command can be used to start a DNS-SD service.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x01
lolen
Minimum payload length
2
0x04
class
Message class: TCP stack
3
0x13
method
Message ID
4
uint8
index
Service index
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x04
class
Message class: TCP stack
3
0x13
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
Table: EVENTS
event
Description
tcpip_dnssd_service_started
Sent when a DNS-SD service is successfully started
tcpip_dnssd_service_failed
Sent when a DNS-SD service startup fails
C Functions
/* Function */
void wifi_cmd_tcpip_dnssd_start_service(
uint8 index
);
/* Callback */
struct wifi_msg_tcpip_dnssd_start_service_rsp_t{
uint16 result
}
void wifi_rsp_tcpip_dnssd_start_service(
const struct wifi_msg_tcpip_dnssd_start_service_rsp_t * msg
)
BGScript Functions
call tcpip_dnssd_start_service(index)(result)
Bluegiga – A Silicon Labs Company
Page 109 of 236
DNS-SD Stop Service--TCP/IP--Wi-Fi
This command can be used to stop a DNS-SD service.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x01
lolen
Minimum payload length
2
0x04
class
Message class: TCP stack
3
0x14
method
Message ID
4
uint8
index
Service index
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x04
class
Message class: TCP stack
3
0x14
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
C Functions
/* Function */
void wifi_cmd_tcpip_dnssd_stop_service(
uint8 index
);
/* Callback */
struct wifi_msg_tcpip_dnssd_stop_service_rsp_t{
uint16 result
}
void wifi_rsp_tcpip_dnssd_stop_service(
const struct wifi_msg_tcpip_dnssd_stop_service_rsp_t * msg
)
BGScript Functions
call tcpip_dnssd_stop_service(index)(result)
Bluegiga – A Silicon Labs Company
Page 110 of 236
5.4.2 Events--TCP/IP--Wi-Fi
These events are related to the TCP stack.
Configuration--TCP/IP--Wi-Fi
This event indicates TCP/IP configuration status.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x0D
lolen
Minimum payload length
2
0x04
class
Message class: TCP stack
3
0x00
method
Message ID
4-7
ipv4
address
The IP address of the local device
8 - 11
ipv4
netmask
Netmask of the local device
12 - 15
ipv4
gateway
The gateway of the local device
16
uint8
use_dhcp
DHCP used
0 = DHCP Client not being used
1 = DHCP Client being used
C Functions
/* Callback */
struct wifi_msg_tcpip_configuration_evt_t{
ipv4 address,
ipv4 netmask,
ipv4 gateway,
uint8 use_dhcp
}
void wifi_evt_tcpip_configuration(
const struct wifi_msg_tcpip_configuration_evt_t * msg
)
BGScript Functions
event tcpip_configuration(address, netmask, gateway, use_dhcp)
Bluegiga – A Silicon Labs Company
Page 111 of 236
DNS Configuration--TCP/IP--Wi-Fi
This event indicates DNS configuration status.
Note that if static IP configuration is in use and no DNS configuration has been provided by the user, the
primary DNS server defaults to 208.67.222.222 (resolver1.opendns.com).
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x05
lolen
Minimum payload length
2
0x04
class
Message class: TCP stack
3
0x01
method
Message ID
4
uint8
index
DNS server ID
0: primary DNS server
1: secondary DNS server
5-8
ipv4
address
The IP address of the DNS server
C Functions
/* Callback */
struct wifi_msg_tcpip_dns_configuration_evt_t{
uint8 index,
ipv4 address
}
void wifi_evt_tcpip_dns_configuration(
const struct wifi_msg_tcpip_dns_configuration_evt_t * msg
)
BGScript Functions
event tcpip_dns_configuration(index, address)
Bluegiga – A Silicon Labs Company
Page 112 of 236
DNS Gethostbyname Result--TCP/IP--Wi-Fi
This event is generated as a response to a DNS Gethostbyname command. If the procedure is successful, this
message contains the IP address of the queried address.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x07
lolen
Minimum payload length
2
0x04
class
Message class: TCP stack
3
0x03
method
Message ID
4-5
uint16
result
Result code
6-9
ipv4
address
The resolved IP address of the server
10
uint8array
name
Name of the server whose IP address was resolved
C Functions
/* Callback */
struct wifi_msg_tcpip_dns_gethostbyname_result_evt_t{
uint16 result,
ipv4 address,
uint8 name_len,
const uint8* name_data
}
void wifi_evt_tcpip_dns_gethostbyname_result(
const struct wifi_msg_tcpip_dns_gethostbyname_result_evt_t * msg
)
BGScript Functions
event tcpip_dns_gethostbyname_result(result, address, name_len, name_data)
Bluegiga – A Silicon Labs Company
Page 113 of 236
DNS-SD Service Failed--TCP/IP--Wi-Fi
This event indicates that a DNS-SD service has failed.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x03
lolen
Minimum payload length
2
0x04
class
Message class: TCP stack
3
0x0A
method
Message ID
4-5
uint16
reason
Failure reason
For values refer to the error code documentation
6
uint8
index
Service index
C Functions
/* Callback */
struct wifi_msg_tcpip_dnssd_service_failed_evt_t{
uint16 reason,
uint8 index
}
void wifi_evt_tcpip_dnssd_service_failed(
const struct wifi_msg_tcpip_dnssd_service_failed_evt_t * msg
)
BGScript Functions
event tcpip_dnssd_service_failed(reason, index)
Bluegiga – A Silicon Labs Company
Page 114 of 236
DNS-SD Service Started--TCP/IP--Wi-Fi
This event indicates that a DNS-SD service has been successfully started.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x01
lolen
Minimum payload length
2
0x04
class
Message class: TCP stack
3
0x09
method
Message ID
4
uint8
index
Service index
C Functions
/* Callback */
struct wifi_msg_tcpip_dnssd_service_started_evt_t{
uint8 index
}
void wifi_evt_tcpip_dnssd_service_started(
const struct wifi_msg_tcpip_dnssd_service_started_evt_t * msg
)
BGScript Functions
event tcpip_dnssd_service_started(index)
Bluegiga – A Silicon Labs Company
Page 115 of 236
DNS-SD Service Stopped--TCP/IP--Wi-Fi
This event indicates that a DNS-SD service has been stopped.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x03
lolen
Minimum payload length
2
0x04
class
Message class: TCP stack
3
0x0B
method
Message ID
4-5
uint16
reason
Stop reason
For values refer to the error code documentation
6
uint8
index
Service index
C Functions
/* Callback */
struct wifi_msg_tcpip_dnssd_service_stopped_evt_t{
uint16 reason,
uint8 index
}
void wifi_evt_tcpip_dnssd_service_stopped(
const struct wifi_msg_tcpip_dnssd_service_stopped_evt_t * msg
)
BGScript Functions
event tcpip_dnssd_service_stopped(reason, index)
Bluegiga – A Silicon Labs Company
Page 116 of 236
Endpoint Status--TCP/IP--Wi-Fi
This event indicates the current status of a TCP/IP endpoint.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x0D
lolen
Minimum payload length
2
0x04
class
Message class: TCP stack
3
0x02
method
Message ID
4
uint8
endpoint
The endpoint index this message describes
5-8
ipv4
local_ip
The local IP address of this endpoint
910
uint16 local_port
The local port of this endpoint
11 14
ipv4
The remote IP address of this endpoint. For server endpoints (which have no
client), this will not contain any valid value.
15 16
uint16 remote_port The port of the remote device. For server endpoints (which have no client),
this will not contain any valid value.
remote_ip
C Functions
/* Callback */
struct wifi_msg_tcpip_endpoint_status_evt_t{
uint8 endpoint,
ipv4 local_ip,
uint16 local_port,
ipv4 remote_ip,
uint16 remote_port
}
void wifi_evt_tcpip_endpoint_status(
const struct wifi_msg_tcpip_endpoint_status_evt_t * msg
)
BGScript Functions
event tcpip_endpoint_status(endpoint, local_ip, local_port, remote_ip, remote_port)
Bluegiga – A Silicon Labs Company
Page 117 of 236
mDNS Failed--TCP/IP--Wi-Fi
This event indicates that a mDNS service has failed.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x02
lolen
Minimum payload length
2
0x04
class
Message class: TCP stack
3
0x07
method
Message ID
4-5
uint16
reason
Failure reason
For values refer to the error code documentation
C Functions
/* Callback */
struct wifi_msg_tcpip_mdns_failed_evt_t{
uint16 reason
}
void wifi_evt_tcpip_mdns_failed(
const struct wifi_msg_tcpip_mdns_failed_evt_t * msg
)
BGScript Functions
event tcpip_mdns_failed(reason)
Bluegiga – A Silicon Labs Company
Page 118 of 236
mDNS Started--TCP/IP--Wi-Fi
This event indicates that a mDNS service has been successfully started.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x00
lolen
Minimum payload length
2
0x04
class
Message class: TCP stack
3
0x06
method
Message ID
C Functions
/* Callback */
void wifi_evt_tcpip_mdns_started(
const void *nul
)
BGScript Functions
event tcpip_mdns_started()
Bluegiga – A Silicon Labs Company
Page 119 of 236
mDNS Stopped--TCP/IP--Wi-Fi
This event indicates that a mDNS service has been stopped.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x02
lolen
Minimum payload length
2
0x04
class
Message class: TCP stack
3
0x08
method
Message ID
4-5
uint16
reason
Stop reason
For values refer to the error code documentation
C Functions
/* Callback */
struct wifi_msg_tcpip_mdns_stopped_evt_t{
uint16 reason
}
void wifi_evt_tcpip_mdns_stopped(
const struct wifi_msg_tcpip_mdns_stopped_evt_t * msg
)
BGScript Functions
event tcpip_mdns_stopped(reason)
Bluegiga – A Silicon Labs Company
Page 120 of 236
UDP Data--TCP/IP--Wi-Fi
This event indicates incoming data from an UDP endpoint. In order to receive this event, instead of the endpoint
Data event, use -1 as the default destination in the Start UDP Server command.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x09
lolen
Minimum payload length
2
0x04
class
Message class: TCP stack
3
0x04
method
Message ID
4
uint8
endpoint
The endpoint which received this data, i.e. to which it was sent
5-8
ipv4
source_address IP address of the client that sent this data
9 - 10
uint16
source_port
Client UDP port where this data was sent from.
11 - 12
uint16array
data
The raw data
C Functions
/* Callback */
struct wifi_msg_tcpip_udp_data_evt_t{
uint8 endpoint,
ipv4 source_address,
uint16 source_port,
uint16 data_len,
const uint8* data_data
}
void wifi_evt_tcpip_udp_data(
const struct wifi_msg_tcpip_udp_data_evt_t * msg
)
BGScript Functions
event tcpip_udp_data(endpoint, source_address, source_port, data_len, data_data)
Bluegiga – A Silicon Labs Company
Page 121 of 236
5.5 Endpoint--Wi-Fi
This class contains commands related to data endpoint control including creation and deletion of endpoints and
data routing.
5.5.1 Commands--endpoint--Wi-Fi
These commands are related to endpoints.
Set Active--endpoint--Wi-Fi
This command can be used to activate or deactivate endpoints. By default endpoints are active, i.e. you can
send data to them, and data can be received from them. This command allows you to temporarily halt the
outgoing data from an endpoint by deactivating it. For example, deactivating a UART endpoint over which
BGAPI is carried, will prevent BGAPI events and responses to go out of that UART interface (but host can still
send BGAPI commands to it). Similarly, deactivating the BGScript endpoint will prevent events to be passed to
the script, thus preventing the calls in it to be executed. Server endpoints however are never active, as they can
neither send nor receive data.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x05
class
Message class: Endpoint
3
0x02
method
Message ID
4
uint8
endpoint
The endpoint to control
5
uint8
active
Endpoint status
0 : inactive
1 : active
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x03
lolen
Minimum payload length
2
0x05
class
Message class: Endpoint
3
0x02
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
6
uint8
endpoint
The endpoint that was controlled
Table: EVENTS
Bluegiga – A Silicon Labs Company
Page 122 of 236
event
Description
endpoint_status
Sent when endpoint status changes
C Functions
/* Function */
void wifi_cmd_endpoint_set_active(
uint8 endpoint,
uint8 active
);
/* Callback */
struct wifi_msg_endpoint_set_active_rsp_t{
uint16 result,
uint8 endpoint
}
void wifi_rsp_endpoint_set_active(
const struct wifi_msg_endpoint_set_active_rsp_t * msg
)
BGScript Functions
call endpoint_set_active(endpoint, active)(result, endpoint)
Bluegiga – A Silicon Labs Company
Page 123 of 236
Send--endpoint--Wi-Fi
This command can be used to send data to a given endpoint.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x05
class
Message class: Endpoint
3
0x00
method
Message ID
4
uint8
endpoint
The index of the endpoint to which the data will be sent.
5
uint8array
data
The RAW data which will be written or sent.
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x03
lolen
Minimum payload length
2
0x05
class
Message class: Endpoint
3
0x00
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
6
uint8
endpoint
The endpoint to which the data was written.
C Functions
/* Function */
void wifi_cmd_endpoint_send(
uint8 endpoint,
uint8 data_len,
const uint8* data_data
);
/* Callback */
struct wifi_msg_endpoint_send_rsp_t{
uint16 result,
uint8 endpoint
}
void wifi_rsp_endpoint_send(
const struct wifi_msg_endpoint_send_rsp_t * msg
)
BGScript Functions
call endpoint_send(endpoint, data_len, data_data)(result, endpoint)
Bluegiga – A Silicon Labs Company
Page 124 of 236
Set Transmit Size--endpoint--Wi-Fi
This command can be used to set the desired transmit packet size: endpoint will buffer outgoing data until
packet size is reached and then transmit it to remote end. This only applies to UDP endpoints, and should
not be used with any other type of endpoint, including TCP. When using packet size 0, the data will be sent
out without a fixed size. If the transmit packet size is set to a higher value than 255, then multiple endpoint_send
command need to be issued to fill the transmit buffer and to effectively send the data to the remote end, due to
the fact that the endpoint_send command can carry at most 255 payload bytes.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x03
lolen
Minimum payload length
2
0x05
class
Message class: Endpoint
3
0x05
method
Message ID
4
uint8
endpoint
The index of the endpoint
5-6
uint16
size
Size of data packet to transmit
0: No defined packet size
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x03
lolen
Minimum payload length
2
0x05
class
Message class: Endpoint
3
0x05
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
6
uint8
endpoint
The endpoint that was configured
C Functions
/* Function */
void wifi_cmd_endpoint_set_transmit_size(
uint8 endpoint,
uint16 size
);
/* Callback */
struct wifi_msg_endpoint_set_transmit_size_rsp_t{
uint16 result,
uint8 endpoint
}
void wifi_rsp_endpoint_set_transmit_size(
const struct wifi_msg_endpoint_set_transmit_size_rsp_t * msg
)
BGScript Functions
Bluegiga – A Silicon Labs Company
Page 125 of 236
call endpoint_set_transmit_size(endpoint, size)(result, endpoint)
Set Streaming--endpoint--Wi-Fi
This command can be used to configure an UART into a streaming or BGAPI mode. When an UART endpoint
is in a streaming mode, the data gets transparently routed to another endpoint like TCP. In BGAPI mode the
data is exposed via BGAPI.
This setting currently only operates on UART endpoints.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x05
class
Message class: Endpoint
3
0x01
method
Message ID
4
uint8
endpoint
The endpoint whose streaming mode should be changed
5
uint8
streaming
Endpoint mode
0 : Use as BGAPI interface
1 : Streaming to another endpoint
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x03
lolen
Minimum payload length
2
0x05
class
Message class: Endpoint
3
0x01
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
6
uint8
endpoint
The endpoint this message refers to
Table: EVENTS
event
Description
endpoint_status
Sent when endpoint status changes
C Functions
/* Function */
void wifi_cmd_endpoint_set_streaming(
uint8 endpoint,
uint8 streaming
);
/* Callback */
struct wifi_msg_endpoint_set_streaming_rsp_t{
uint16 result,
uint8 endpoint
Bluegiga – A Silicon Labs Company
Page 126 of 236
}
void wifi_rsp_endpoint_set_streaming(
const struct wifi_msg_endpoint_set_streaming_rsp_t * msg
)
BGScript Functions
call endpoint_set_streaming(endpoint, streaming)(result, endpoint)
Bluegiga – A Silicon Labs Company
Page 127 of 236
Set Streaming Destination--endpoint--Wi-Fi
This command can be used to set the destination where data from an endpoint will be routed to.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x05
class
Message class: Endpoint
3
0x03
method
Message ID
4
uint8
endpoint
The endpoint which to control
5
int8
streaming_destination
The destination for the data
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x03
lolen
Minimum payload length
2
0x05
class
Message class: Endpoint
3
0x03
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
6
uint8
endpoint
The endpoint that was controlled
Table: EVENTS
event
Description
endpoint_status
Sent when endpoint status changes
C Functions
/* Function */
void wifi_cmd_endpoint_set_streaming_destination(
uint8 endpoint,
int8 streaming_destination
);
/* Callback */
struct wifi_msg_endpoint_set_streaming_destination_rsp_t{
uint16 result,
uint8 endpoint
}
void wifi_rsp_endpoint_set_streaming_destination(
const struct wifi_msg_endpoint_set_streaming_destination_rsp_t * msg
)
BGScript Functions
call endpoint_set_streaming_destination(endpoint, streaming_destination)(result, endpoint)
Bluegiga – A Silicon Labs Company
Page 128 of 236
Bluegiga – A Silicon Labs Company
Page 129 of 236
Close--endpoint--Wi-Fi
This command can be used to close an endpoint. This command is valid only for UDP or TCP endpoints.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x01
lolen
Minimum payload length
2
0x05
class
Message class: Endpoint
3
0x04
method
Message ID
4
uint8
endpoint
The index of the endpoint to close
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x03
lolen
Minimum payload length
2
0x05
class
Message class: Endpoint
3
0x04
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
6
uint8
endpoint
The endpoint that was closed
Table: EVENTS
event
Description
endpoint_status
Sent when endpoint status changes
C Functions
/* Function */
void wifi_cmd_endpoint_close(
uint8 endpoint
);
/* Callback */
struct wifi_msg_endpoint_close_rsp_t{
uint16 result,
uint8 endpoint
}
void wifi_rsp_endpoint_close(
const struct wifi_msg_endpoint_close_rsp_t * msg
)
BGScript Functions
call endpoint_close(endpoint)(result, endpoint)
Bluegiga – A Silicon Labs Company
Page 130 of 236
Disable--endpoint--Wi-Fi
This command can be used to disable an UART type endpoint. This command effectively turns down an UART
interface until the module is reset or power-cycled. When an UART interface is disabled its pins go to highimpedance state.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x01
lolen
Minimum payload length
2
0x05
class
Message class: Endpoint
3
0x06
method
Message ID
4
uint8
endpoint
Index of the endpoint to disable
0: UART0
1: UART1
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x03
lolen
Minimum payload length
2
0x05
class
Message class: Endpoint
3
0x06
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
6
uint8
endpoint
The index of the endpoint
C Functions
/* Function */
void wifi_cmd_endpoint_disable(
uint8 endpoint
);
/* Callback */
struct wifi_msg_endpoint_disable_rsp_t{
uint16 result,
uint8 endpoint
}
void wifi_rsp_endpoint_disable(
const struct wifi_msg_endpoint_disable_rsp_t * msg
)
BGScript Functions
call endpoint_disable(endpoint)(result, endpoint)
Bluegiga – A Silicon Labs Company
Page 131 of 236
5.5.2 Events--endpoint--Wi-Fi
These events are related to endpoints.
Status--endpoint--Wi-Fi
This event indicates an endpoint's status.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x08
lolen
Minimum payload length
2
0x05
class
Message class: Endpoint
3
0x02
method
Message ID
4
uint8
endpoint
The index of the endpoint whose status this event describes
5-8
uint32
type
The type of endpoint, see the endpoint type enumeration
9
uint8
streaming
Endpoint mode
0 : Endpoint is connected to BGAPI
1 : Endpoint is streaming to another endpoint
10
int8
destination
The index of the endpoint to which the incoming data goes
11
uint8
active
Endpoint status
0 : receiving and sending of data is blocked
1 : receiving and sending is allowed.
C Functions
/* Callback */
struct wifi_msg_endpoint_status_evt_t{
uint8 endpoint,
uint32 type,
uint8 streaming,
int8 destination,
uint8 active
}
void wifi_evt_endpoint_status(
const struct wifi_msg_endpoint_status_evt_t * msg
)
BGScript Functions
event endpoint_status(endpoint, type, streaming, destination, active)
Bluegiga – A Silicon Labs Company
Page 132 of 236
Data--endpoint--Wi-Fi
This event indicates incoming data from an endpoint.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x02
lolen
Minimum payload length
2
0x05
class
Message class: Endpoint
3
0x01
method
Message ID
4
uint8
endpoint
The endpoint which received this data, i.e. to which it was sent.
5
uint8array
data
The raw data
C Functions
/* Callback */
struct wifi_msg_endpoint_data_evt_t{
uint8 endpoint,
uint8 data_len,
const uint8* data_data
}
void wifi_evt_endpoint_data(
const struct wifi_msg_endpoint_data_evt_t * msg
)
BGScript Functions
event endpoint_data(endpoint, data_len, data_data)
Bluegiga – A Silicon Labs Company
Page 133 of 236
Closing--endpoint--Wi-Fi
This event indicates an endpoint is closing or indicates that the remote end has terminated the connection. The
event should be acknowledged by calling the endpoint close command or otherwise the software will not re-use
the endpoint index.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x03
lolen
Minimum payload length
2
0x05
class
Message class: Endpoint
3
0x03
method
Message ID
4-5
uint16
reason
Zero indicates success. For other values refer to the error code documentation
6
uint8
endpoint
The endpoint which is closing
C Functions
/* Callback */
struct wifi_msg_endpoint_closing_evt_t{
uint16 reason,
uint8 endpoint
}
void wifi_evt_endpoint_closing(
const struct wifi_msg_endpoint_closing_evt_t * msg
)
BGScript Functions
event endpoint_closing(reason, endpoint)
Bluegiga – A Silicon Labs Company
Page 134 of 236
Error
This event indicates an error in an endpoint.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x03
lolen
Minimum payload length
2
0x05
class
Message class: Endpoint
3
0x04
method
Message ID
4-5
uint16
reason
Error reason
For values refer to the error code documentation
6
uint8
endpoint
The endpoint where the error occurred
C Functions
/* Callback */
struct wifi_msg_endpoint_error_evt_t{
uint16 reason,
uint8 endpoint
}
void wifi_evt_endpoint_error(
const struct wifi_msg_endpoint_error_evt_t * msg
)
BGScript Functions
event endpoint_error(reason, endpoint)
Bluegiga – A Silicon Labs Company
Page 135 of 236
Syntax Error
This event indicates that a protocol error was detected in BGAPI command parser. This event is triggered if a
BGAPI command from the host contains syntax error(s), or if a command is only partially sent. Then the BGAPI
parser has a 1 second command timeout and if a valid command is not transmitted within this timeout an error
is raised and the partial or wrong command will be ignored.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x03
lolen
Minimum payload length
2
0x05
class
Message class: Endpoint
3
0x00
method
Message ID
4-5
uint16
result
Error reason
Typical errors are:
- 0x0184 Command Not Recognized
- 0x0185 Timeout
For these and other error codes refer to the Error codes documentation
6
uint8
endpoint
The BGAPI endpoint where the error occurred
C Functions
/* Callback */
struct wifi_msg_endpoint_syntax_error_evt_t{
uint16 result,
uint8 endpoint
}
void wifi_evt_endpoint_syntax_error(
const struct wifi_msg_endpoint_syntax_error_evt_t * msg
)
BGScript Functions
event endpoint_syntax_error(result, endpoint)
Bluegiga – A Silicon Labs Company
Page 136 of 236
5.5.3 Enumerations--endpoint--Wi-Fi
These enumerations are related to endpoints.
Endpoint types--endpoint--Wi-Fi
These enumerations define the endpoint types. Not to be confused with the dynamic endpoint indexes used e.g.
with command endpoint_send.
Table: VALUES
Value
Name
Description
0
endpoint_free
Endpoint is not in use
1
endpoint_uart
Endpoint of type hardware UART
2
endpoint_usb
USB
4
endpoint_tcp
TCP client
8
endpoint_tcp_server
TCP server
16
endpoint_udp
UDP client
32
endpoint_udp_server
UDP server
64
endpoint_script
Scripting
128
endpoint_wait_close
Waiting for closing
256
endpoint_spi
SPI
512
endpoint_i2c
I2C
1024
endpoint_drop
Drop all data sent to this
Bluegiga – A Silicon Labs Company
Page 137 of 236
5.6 Hardware--Wi-Fi
This class contains commands related to hardware peripherals and interfaces.
5.6.1 Commands--hardware--Wi-Fi
Hardware commands
ADC Read--hardware--Wi-Fi
This command is used to read the devices A/D converter.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x01
lolen
Minimum payload length
2
0x06
class
Message class: Hardware
3
0x09
method
Message ID
4
uint8
input
ADC input.
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x05
lolen
Minimum payload length
2
0x06
class
Message class: Hardware
3
0x09
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
6
uint8
input
ADC input.
7-8
uint16
value
ADC value
C Functions
/* Function */
void wifi_cmd_hardware_adc_read(
uint8 input
);
/* Callback */
struct wifi_msg_hardware_adc_read_rsp_t{
uint16 result,
uint8 input,
uint16 value
}
void wifi_rsp_hardware_adc_read(
const struct wifi_msg_hardware_adc_read_rsp_t * msg
)
Bluegiga – A Silicon Labs Company
Page 138 of 236
BGScript Functions
call hardware_adc_read(input)(result, input, value)
Bluegiga – A Silicon Labs Company
Page 139 of 236
Change Notification Config--hardware--Wi-Fi
This command can be used to configure change notifications (CN). The PIC32 micro controller has a limited
number of standard GPIO interrupts. Change notifications can be used in a similar way to GPIO interrupts in
most cases but they are not identical with each other and operate on different pins. This command can be used
to configure for which pins the change notification interrupts are enabled. A list of pins and corresponding
change notification source see WF121 Datasheet page 9, Table 2: Multifunction pad descriptions. More detailed
information can be found in the PIC32 Datasheet in the chapter discussing change notifications.
WF121 pin #
PIC32 pin
Change notification bit
2
RB15
12
14
RB1
3
15
RB0
2
24
RB5
7
33
RC13
1
34
RC14
0
35
RF4
17
36
RF5
18
42
RD6
15
43
RD7
16
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x04
lolen
Minimum payload length
2
0x06
class
Message class: Hardware
3
0x02
method
Message ID
4-7
uint32
enable
Change notification bits to enable
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x06
class
Message class: Hardware
3
0x02
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
Table: EVENTS
Bluegiga – A Silicon Labs Company
Page 140 of 236
Event
Description
hardware
change_notification
Sent after a pin state change has been detected, and the pin change notification for
that pin is enabled. The CN command must be issued again before getting the next
event.
C Functions
/* Function */
void wifi_cmd_hardware_change_notification_config(
uint32 enable
);
/* Callback */
struct wifi_msg_hardware_change_notification_config_rsp_t{
uint16 result
}
void wifi_rsp_hardware_change_notification_config(
const struct wifi_msg_hardware_change_notification_config_rsp_t * msg
)
BGScript Functions
call hardware_change_notification_config(enable)(result)
Bluegiga – A Silicon Labs Company
Page 141 of 236
Change Notification Pullup--hardware--Wi-Fi
This command can be used to configure change notification pull-up settings. For a detailed discussion
concerning change notifications, see the Change Notification Config command.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x04
lolen
Minimum payload length
2
0x06
class
Message class: Hardware
3
0x03
method
Message ID
4-7
uint32
pullup
Bitmask for which of the change notification pins have pull-ups enabled
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x06
class
Message class: Hardware
3
0x03
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
C Functions
/* Function */
void wifi_cmd_hardware_change_notification_pullup(
uint32 pullup
);
/* Callback */
struct wifi_msg_hardware_change_notification_pullup_rsp_t{
uint16 result
}
void wifi_rsp_hardware_change_notification_pullup(
const struct wifi_msg_hardware_change_notification_pullup_rsp_t * msg
)
BGScript Functions
call hardware_change_notification_pullup(pullup)(result)
Bluegiga – A Silicon Labs Company
Page 142 of 236
External Interrupt Config--hardware--Wi-Fi
This command can be used to configure pins which will generate interrupts.
In the WF121 Wi-Fi module there are four pins which support interrupts: RD0/INT0, RD9/INT2, RD10/INT3,
RD11/INT4. INT1 is reserved for WF121's internal use and cannot be used for other purposes. Interrupts can be
triggered either on the rising edge or the falling edge.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x06
class
Message class: Hardware
3
0x01
method
Message ID
4
uint8
enable
External interrupt bits to enable
INT0 : 0x01
INT2 : 0x04
INT3 : 0x08
INT4 : 0x10
Example: interrupts INT0 and INT4 are enabled with value of 0x5
5
uint8
polarity
External interrupt polarity bits, rising edge if set, falling edge otherwise
INT0 : 0x01
INT2 : 0x04
INT3 : 0x08
INT4 : 0x10
Example: INT0 as falling and INT2 as rising are set with value of 0x4
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x06
class
Message class: Hardware
3
0x01
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
Table: EVENTS
Event
Description
hardware external_interrupt
Sent after external interrupt detected.
C Functions
/* Function */
Bluegiga – A Silicon Labs Company
Page 143 of 236
void wifi_cmd_hardware_external_interrupt_config(
uint8 enable,
uint8 polarity
);
/* Callback */
struct wifi_msg_hardware_external_interrupt_config_rsp_t{
uint16 result
}
void wifi_rsp_hardware_external_interrupt_config(
const struct wifi_msg_hardware_external_interrupt_config_rsp_t * msg
)
BGScript Functions
call hardware_external_interrupt_config(enable, polarity)(result)
Bluegiga – A Silicon Labs Company
Page 144 of 236
IO Port Config Direction--hardware--Wi-Fi
This command can be used to configure the data flow direction of I/O-port(s).
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x05
lolen
Minimum payload length
2
0x06
class
Message class: Hardware
3
0x04
method
Message ID
4
uint8
port
Port index
0:A
1:B
2:C
3:D
4:E
5:F
6:G
5-6
uint16
mask
Bit mask of which pins on the port this command affects.
7-8
uint16
direction
The bit mask describing which are inputs and which are outputs.
0 : Output
1 : Input
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x06
class
Message class: Hardware
3
0x04
method
Message ID
4-5
uint16
result
Return code.
0 : Success
non-zero : An error occurred
For other values refer to the error code documentation
C Functions
/* Function */
void wifi_cmd_hardware_io_port_config_direction(
uint8 port,
uint16 mask,
uint16 direction
);
/* Callback */
struct wifi_msg_hardware_io_port_config_direction_rsp_t{
uint16 result
}
void wifi_rsp_hardware_io_port_config_direction(
const struct wifi_msg_hardware_io_port_config_direction_rsp_t * msg
)
Bluegiga – A Silicon Labs Company
Page 145 of 236
BGScript Functions
call hardware_io_port_config_direction(port, mask, direction)(result)
Bluegiga – A Silicon Labs Company
Page 146 of 236
IO Port Config Open Drain--hardware--Wi-Fi
This command can be used to configure I/O-port open drain functionality. Open drain means that when the pin
is in high state, it is in high impedance state and when low it is able to sink current. Open drain is sometimes
also called Open Collector.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x05
lolen
Minimum payload length
2
0x06
class
Message class: Hardware
3
0x05
method
Message ID
4
uint8
port
Port index
0:A
1:B
2:C
3:D
4:E
5:F
6:G
5-6
uint16
mask
Bitmask of which pins on the port this command affects
7-8
uint16
open_drain
Bitmask of which pins are configured to be open drain.
For each bit this means:
0 : Open drain disabled
1 : Open drain enabled
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x06
class
Message class: Hardware
3
0x05
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
C Functions
/* Function */
void wifi_cmd_hardware_io_port_config_open_drain(
uint8 port,
uint16 mask,
uint16 open_drain
);
/* Callback */
struct wifi_msg_hardware_io_port_config_open_drain_rsp_t{
uint16 result
}
void wifi_rsp_hardware_io_port_config_open_drain(
const struct wifi_msg_hardware_io_port_config_open_drain_rsp_t * msg
Bluegiga – A Silicon Labs Company
Page 147 of 236
)
BGScript Functions
call hardware_io_port_config_open_drain(port, mask, open_drain)(result)
Bluegiga – A Silicon Labs Company
Page 148 of 236
IO Port Read--hardware--Wi-Fi
This command can be used to read the status of pins of an I/O-port.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x03
lolen
Minimum payload length
2
0x06
class
Message class: Hardware
3
0x07
method
Message ID
4
uint8
port
Port index:
0:A
1:B
2:C
3:D
4:E
5:F
6:G
5-6
uint16
mask
Bitmask of which pins on the port should be read. For each bit in the bitmask:
0 : Don't read
1 : Read
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x05
lolen
Minimum payload length
2
0x06
class
Message class: Hardware
3
0x07
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
6
uint8
port
Port index
7-8
uint16
data
port data
C Functions
/* Function */
void wifi_cmd_hardware_io_port_read(
uint8 port,
uint16 mask
);
/* Callback */
struct wifi_msg_hardware_io_port_read_rsp_t{
uint16 result,
uint8 port,
uint16 data
}
void wifi_rsp_hardware_io_port_read(
const struct wifi_msg_hardware_io_port_read_rsp_t * msg
Bluegiga – A Silicon Labs Company
Page 149 of 236
)
BGScript Functions
call hardware_io_port_read(port, mask)(result, port, data)
Bluegiga – A Silicon Labs Company
Page 150 of 236
IO Port Write--hardware--Wi-Fi
This command can be used to write the pins of an I/O-port.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x05
lolen
Minimum payload length
2
0x06
class
Message class: Hardware
3
0x06
method
Message ID
4
uint8
port
Port index:
0:A
1:B
2:C
3:D
4:E
5:F
6:G
5-6
uint16 mask
Bit mask of which pins on the port this command affects. For each bit in the bit
mask: 0 = Don't modify/write, 1 = modify/write
7-8
uint16 data
Bit mask of which pins to set. For each bit in the bit mask:
0 : low
1 : high
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x06
class
Message class: Hardware
3
0x06
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
C Functions
/* Function */
void wifi_cmd_hardware_io_port_write(
uint8 port,
uint16 mask,
uint16 data
);
/* Callback */
struct wifi_msg_hardware_io_port_write_rsp_t{
uint16 result
}
void wifi_rsp_hardware_io_port_write(
const struct wifi_msg_hardware_io_port_write_rsp_t * msg
)
Bluegiga – A Silicon Labs Company
Page 151 of 236
BGScript Functions
call hardware_io_port_write(port, mask, data)(result)
Bluegiga – A Silicon Labs Company
Page 152 of 236
Output Compare--hardware--Wi-Fi
This command can be used to define compare settings, e.g., for PWM purposes. Output compare output is
disabled when the module enters sleep mode. The <timer> tag in the hardware.xml file must be configured
properly if using this command.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x08
lolen
Minimum payload length
2
0x06
class
Message class: Hardware
3
0x08
method
Message ID
4
uint8
index
Index of output compare module. (1-5)
5
uint8
bit32
Is 32-bit mode selected.
0: 16-bit
1: 32-bit, Requires timer to be configured for 32.
6
uint8
timer
Timer to use for comparison.
2: Timer 2
3: Timer 3
7
uint8
mode
comparison mode
0: Output compare peripheral is disabled but continues to draw current
1: Initialize OCx pin low; compare event forces OCx pin high
2: Initialize OCx pin high; compare event forces OCx pin low
3: Compare event toggles OCx pin
4: Initialize OCx pin low; generate single output pulse on OCx pin
5: Initialize OCx pin low; generate continuous output pulses on OCx pin
6: PWM mode on OCx; Fault pin disabled
7: PWM mode on OCx; Fault pin enabled
8 - 11
uint32
compare_value 0-0xFFFF for 16-bit
0-0xFFFFFFFF for 32-bit
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x06
class
Message class: Hardware
3
0x08
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
C Functions
/* Function */
void wifi_cmd_hardware_output_compare(
uint8 index,
uint8 bit32,
Bluegiga – A Silicon Labs Company
Page 153 of 236
uint8 timer,
uint8 mode,
uint32 compare_value
);
/* Callback */
struct wifi_msg_hardware_output_compare_rsp_t{
uint16 result
}
void wifi_rsp_hardware_output_compare(
const struct wifi_msg_hardware_output_compare_rsp_t * msg
)
BGScript Functions
call hardware_output_compare(index, bit32, timer, mode, compare_value)(result)
Bluegiga – A Silicon Labs Company
Page 154 of 236
RTC Init
This command can be used to initialize the internal Real Time Clock (RTC).
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x03
lolen
Minimum payload length
2
0x06
class
Message class: Hardware
3
0x0A
method
Message ID
4
uint8
enable
Enable/Disable RTC.
5-6
int16
drift
Drift of clock. Added to 32.768kHz SOSC every minute.
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x06
class
Message class: Hardware
3
0x0A
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
C Functions
/* Function */
void wifi_cmd_hardware_rtc_init(
uint8 enable,
int16 drift
);
/* Callback */
struct wifi_msg_hardware_rtc_init_rsp_t{
uint16 result
}
void wifi_rsp_hardware_rtc_init(
const struct wifi_msg_hardware_rtc_init_rsp_t * msg
)
BGScript Functions
call hardware_rtc_init(enable, drift)(result)
Bluegiga – A Silicon Labs Company
Page 155 of 236
RTC Set Time
This command can be used to set the internal Real Time Clock (RTC) time.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x08
lolen
Minimum payload length
2
0x06
class
Message class: Hardware
3
0x0B
method
Message ID
4-5
int16
year
Current year of RTC time (2000-2099)
6
int8
month
Current month of RTC time (1-12)
7
int8
day
Current day of RTC time (1-31)
8
int8
weekday
Current weekday of RTC time (0-6 sunday-saturday)
9
int8
hour
Current hour of RTC time (0-23)
10
int8
minute
Current minute of RTC time (0-59)
11
int8
second
Current second of RTC time (0-59)
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x06
class
Message class: Hardware
3
0x0B
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
C Functions
/* Function */
void wifi_cmd_hardware_rtc_set_time(
int16 year,
int8 month,
int8 day,
int8 weekday,
int8 hour,
int8 minute,
int8 second
);
/* Callback */
struct wifi_msg_hardware_rtc_set_time_rsp_t{
uint16 result
}
void wifi_rsp_hardware_rtc_set_time(
const struct wifi_msg_hardware_rtc_set_time_rsp_t * msg
)
Bluegiga – A Silicon Labs Company
Page 156 of 236
BGScript Functions
call hardware_rtc_set_time(year, month, day, weekday, hour, minute, second)(result)
Bluegiga – A Silicon Labs Company
Page 157 of 236
RTC Get Time
This commands can be used to read the internal Real Time Clock (RTC) value.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x00
lolen
Minimum payload length
2
0x06
class
Message class: Hardware
3
0x0C
method
Message ID
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x0A
lolen
Minimum payload length
2
0x06
class
Message class: Hardware
3
0x0C
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
6-7
int16
year
Current year of RTC time (2000-2099)
8
int8
month
Current month of RTC time (1-12)
9
int8
day
Current day of RTC time (1-31)
10
int8
weekday
Current weekday of RTC time (0-6 sunday-saturday)
11
int8
hour
Current hour of RTC time (0-23)
12
int8
minute
Current minute of RTC time (0-59)
13
int8
second
Current second of RTC time (0-59)
C Functions
/* Function */
void wifi_cmd_hardware_rtc_get_time(
void
);
/* Callback */
struct wifi_msg_hardware_rtc_get_time_rsp_t{
uint16 result,
int16 year,
int8 month,
int8 day,
int8 weekday,
int8 hour,
int8 minute,
int8 second
}
void wifi_rsp_hardware_rtc_get_time(
const struct wifi_msg_hardware_rtc_get_time_rsp_t * msg
)
Bluegiga – A Silicon Labs Company
Page 158 of 236
BGScript Functions
call hardware_rtc_get_time()(result, year, month, day, weekday, hour, minute, second)
Bluegiga – A Silicon Labs Company
Page 159 of 236
RTC Set Alarm
This command can be used to set an alarm for the internal Real Time Clock (RTC).
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x09
lolen
Minimum payload length
2
0x06
class
Message class: Hardware
3
0x0D
method
Message ID
4
uint8
month
Month for alarm (1-12), -1 for don't care
5
uint8
day
Day for alarm (1-31), -1 for don't care
6
int8
weekday
Weekday for alarm (0-6 sunday-saturday)
7
uint8
hour
Hour for alarm (0-23), -1 for don't care
8
uint8
minute
Minute for alarm (0-59), -1 for don't care
9
uint8
second
Second for alarm (0-59), -1 for don't care
10
uint8
repeat_mask
repeat mask for matching alarm time
11 - 12
int16
repeat_count
How often alarm repeats (0=no limit)
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x06
class
Message class: Hardware
3
0x0D
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
Table: EVENTS
event
Description
hardware_rtc_alarm
Sent when RTC alarm is triggered
C Functions
/* Function */
void wifi_cmd_hardware_rtc_set_alarm(
uint8 month,
uint8 day,
int8 weekday,
uint8 hour,
uint8 minute,
uint8 second,
uint8 repeat_mask,
Bluegiga – A Silicon Labs Company
Page 160 of 236
int16 repeat_count
);
/* Callback */
struct wifi_msg_hardware_rtc_set_alarm_rsp_t{
uint16 result
}
void wifi_rsp_hardware_rtc_set_alarm(
const struct wifi_msg_hardware_rtc_set_alarm_rsp_t * msg
)
BGScript Functions
call hardware_rtc_set_alarm(month, day, weekday, hour, minute, second, repeat_mask, repeat_count)
(result)
Bluegiga – A Silicon Labs Company
Page 161 of 236
Set Soft Timer--hardware--Wi-Fi
This command can be used to enable the software timer. Multiple concurrent timers can be running at the same
time.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x06
lolen
Minimum payload length
2
0x06
class
Message class: Hardware
3
0x00
method
Message ID
4-7
uint32
time
Interval between how often to send events, in milliseconds.
If time is 0, removes the scheduled timer
8
uint8
handle
Handle that is returned with event
9
uint8
single_shot
0 : false (Timer is repeating)
1 : true (Timer runs only once)
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x06
class
Message class: Hardware
3
0x00
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
Table: EVENTS
Event
Description
hardware soft_timer
Sent after specified interval
C Functions
/* Function */
void wifi_cmd_hardware_set_soft_timer(
uint32 time,
uint8 handle,
uint8 single_shot
);
/* Callback */
struct wifi_msg_hardware_set_soft_timer_rsp_t{
uint16 result
}
void wifi_rsp_hardware_set_soft_timer(
const struct wifi_msg_hardware_set_soft_timer_rsp_t * msg
)
Bluegiga – A Silicon Labs Company
Page 162 of 236
BGScript Functions
call hardware_set_soft_timer(time, handle, single_shot)(result)
Bluegiga – A Silicon Labs Company
Page 163 of 236
UART Conf Get--hardware--Wi-Fi
This command can be used to read the current configuration of an UART interface.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x01
lolen
Minimum payload length
2
0x06
class
Message class: Hardware
3
0x0F
method
Message ID
4
uint8
id
UART id
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x06
class
Message class: Hardware
3
0x0F
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
Table: EVENTS
event
Description
hardware_uart_conf
UART configuration
C Functions
/* Function */
void wifi_cmd_hardware_uart_conf_get(
uint8 id
);
/* Callback */
struct wifi_msg_hardware_uart_conf_get_rsp_t{
uint16 result
}
void wifi_rsp_hardware_uart_conf_get(
const struct wifi_msg_hardware_uart_conf_get_rsp_t * msg
)
BGScript Functions
call hardware_uart_conf_get(id)(result)
Bluegiga – A Silicon Labs Company
Page 164 of 236
UART Conf Set--hardware--Wi-Fi
This command can be used to re-configure an UART interface.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x09
lolen
Minimum payload length
2
0x06
class
Message class: Hardware
3
0x0E
method
Message ID
4
uint8
id
UART ID
5-8
uint32
rate
Baud rate e.g. 115200
9
uint8
data_bits
Data bits
Values: 8 or 9
10
uint8
stop_bits
Stop bits
Values: 1 or 2
11
uint8
parity
Parity
0: none
1: odd
2: even
12
uint8
flow_ctrl
Flow control
0: none
1: RTS/CTS
2: RTS
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x06
class
Message class: Hardware
3
0x0E
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
C Functions
/* Function */
void wifi_cmd_hardware_uart_conf_set(
Bluegiga – A Silicon Labs Company
Page 165 of 236
uint8 id,
uint32 rate,
uint8 data_bits,
uint8 stop_bits,
uint8 parity,
uint8 flow_ctrl
);
/* Callback */
struct wifi_msg_hardware_uart_conf_set_rsp_t{
uint16 result
}
void wifi_rsp_hardware_uart_conf_set(
const struct wifi_msg_hardware_uart_conf_set_rsp_t * msg
)
BGScript Functions
call hardware_uart_conf_set(id, rate, data_bits, stop_bits, parity, flow_ctrl)(result)
Bluegiga – A Silicon Labs Company
Page 166 of 236
5.6.2 Enumerations--hardware--Wi-Fi
These enumerations are related to hardware.
RTC Alarm repeat--hardware--Wi-Fi
These enumerations define how often an alarm repeats.
Table: VALUES
Value
Name
Description
0
hardware_alarm_every_half_second
Repeat every second
1
hardware_alarm_every_second
Repeat every second
2
hardware_alarm_every_ten_seconds
Repeat every ten seconds
3
hardware_alarm_every_minute
Repeat every minute
4
hardware_alarm_every_ten_minutes
Repeat every ten minutes
5
hardware_alarm_every_hour
Repeat every hour
6
hardware_alarm_every_day
Repeat every day
7
hardware_alarm_every_week
Repeat every week
8
hardware_alarm_every_month
Repeat every month
9
hardware_alarm_every_year
Repeat every year
Bluegiga – A Silicon Labs Company
Page 167 of 236
5.6.3 Events--hardware--Wi-Fi
These events are related to hardware.
Change Notification--hardware--Wi-Fi
This event indicates an IO port status change and provides a time stamp when the change occurred.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x04
lolen
Minimum payload length
2
0x06
class
Message class: Hardware
3
0x01
method
Message ID
4-7
uint32
timestamp
Timestamp of when the change occurred
C Functions
/* Callback */
struct wifi_msg_hardware_change_notification_evt_t{
uint32 timestamp
}
void wifi_evt_hardware_change_notification(
const struct wifi_msg_hardware_change_notification_evt_t * msg
)
BGScript Functions
event hardware_change_notification(timestamp)
Bluegiga – A Silicon Labs Company
Page 168 of 236
External Interrupt--hardware--Wi-Fi
This event is generated when an external interrupt occurs and provides a time stamp and IRQ. The IRQ's and
their corresponding pins are documented in the WF121 datasheet, page 9, table 2.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x05
lolen
Minimum payload length
2
0x06
class
Message class: Hardware
3
0x02
method
Message ID
4
uint8
irq
IRQ index
5-8
uint32
timestamp
Time stamp of when the interrupt occurred
Table: GPIO interrupts
WF121 pin number
IRQ
IRQ index
37
INT 4
4
38
INT 0
0
44
INT 2
2
46
INT 3
3
C Functions
/* Callback */
struct wifi_msg_hardware_external_interrupt_evt_t{
uint8 irq,
uint32 timestamp
}
void wifi_evt_hardware_external_interrupt(
const struct wifi_msg_hardware_external_interrupt_evt_t * msg
)
BGScript Functions
event hardware_external_interrupt(irq, timestamp)
Bluegiga – A Silicon Labs Company
Page 169 of 236
RTC Alarm
This event indicates and alarm generated from the internal Real Time Clock (RTC).
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x00
lolen
Minimum payload length
2
0x06
class
Message class: Hardware
3
0x03
method
Message ID
C Functions
/* Callback */
void wifi_evt_hardware_rtc_alarm(
const void *nul
)
BGScript Functions
event hardware_rtc_alarm()
Bluegiga – A Silicon Labs Company
Page 170 of 236
Soft Timer--hardware--Wi-Fi
This event indicates that a software timer has reached the defined count (elapsed).
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x01
lolen
Minimum payload length
2
0x06
class
Message class: Hardware
3
0x00
method
Message ID
4
uint8
handle
Timer handle
C Functions
/* Callback */
struct wifi_msg_hardware_soft_timer_evt_t{
uint8 handle
}
void wifi_evt_hardware_soft_timer(
const struct wifi_msg_hardware_soft_timer_evt_t * msg
)
BGScript Functions
event hardware_soft_timer(handle)
Bluegiga – A Silicon Labs Company
Page 171 of 236
UART Conf--hardware--Wi-Fi
This event reports the current configuration of a UART interface. It follows the command
hardware_uart_conf_get.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x09
lolen
Minimum payload length
2
0x06
class
Message class: Hardware
3
0x04
method
Message ID
4
uint8
id
UART id
5-8
uint32
rate
Baud rate in bps e.g. 115200
9
uint8
data_bits
Data bits 8 or 9
10
uint8
stop_bits
Stop bits 1 or 2
11
uint8
parity
Parity 0=none, 1=odd, 2=even
12
uint8
flow_ctrl
Flow control 0=none, 1=rts/cts 2=rts
C Functions
/* Callback */
struct wifi_msg_hardware_uart_conf_evt_t{
uint8 id,
uint32 rate,
uint8 data_bits,
uint8 stop_bits,
uint8 parity,
uint8 flow_ctrl
}
void wifi_evt_hardware_uart_conf(
const struct wifi_msg_hardware_uart_conf_evt_t * msg
)
BGScript Functions
event hardware_uart_conf(id, rate, data_bits, stop_bits, parity, flow_ctrl)
Bluegiga – A Silicon Labs Company
Page 172 of 236
5.7 I2C--Wi-Fi
This class contains commands related to I2C peripherals.
5.7.1 Commands--I2C--Wi-Fi
These commands are related to I2C interface.
Start Read--I2C--Wi-Fi
This command can be used to start I2C transmission for reading data. The data is transferred via Endpoint Data
events.
Only I2C master functionality is supported.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x04
lolen
Minimum payload length
2
0x08
class
Message class: I2C
3
0x00
method
Message ID
4
uint8
endpoint
I2C endpoint to use.
5-6
uint16
slave_address
Slave address to use
7
uint8
length
Amount of data to move
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x08
class
Message class: I2C
3
0x00
method
Message ID
4-5
uint16
result
Result code
0: success
Non-zero: an error occurred
For other values refer to the error code documentation
C Functions
/* Function */
void wifi_cmd_i2c_start_read(
uint8 endpoint,
uint16 slave_address,
uint8 length
);
/* Callback */
struct wifi_msg_i2c_start_read_rsp_t{
Bluegiga – A Silicon Labs Company
Page 173 of 236
uint16 result
}
void wifi_rsp_i2c_start_read(
const struct wifi_msg_i2c_start_read_rsp_t * msg
)
BGScript Functions
call i2c_start_read(endpoint, slave_address, length)(result)
Bluegiga – A Silicon Labs Company
Page 174 of 236
Start Write--I2C--Wi-Fi
This command can be used to prepare an I2C endpoint for data transmission. The data is sent using the
Endpoint Send command.
Only I2C master functionality is supported.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x03
lolen
Minimum payload length
2
0x08
class
Message class: I2C
3
0x01
method
Message ID
4
uint8
endpoint
I2C endpoint to use.
5-6
uint16
slave_address
Slave address to use
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x08
class
Message class: I2C
3
0x01
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
C Functions
/* Function */
void wifi_cmd_i2c_start_write(
uint8 endpoint,
uint16 slave_address
);
/* Callback */
struct wifi_msg_i2c_start_write_rsp_t{
uint16 result
}
void wifi_rsp_i2c_start_write(
const struct wifi_msg_i2c_start_write_rsp_t * msg
)
BGScript Functions
call i2c_start_write(endpoint, slave_address)(result)
Bluegiga – A Silicon Labs Company
Page 175 of 236
Stop--I2C--Wi-Fi
This command can be used to stop the I2C transmission.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x01
lolen
Minimum payload length
2
0x08
class
Message class: I2C
3
0x02
method
Message ID
4
uint8
endpoint
I2C endpoint to use.
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x08
class
Message class: I2C
3
0x02
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero: an error occurred
For other values refer to the error code documentation
C Functions
/* Function */
void wifi_cmd_i2c_stop(
uint8 endpoint
);
/* Callback */
struct wifi_msg_i2c_stop_rsp_t{
uint16 result
}
void wifi_rsp_i2c_stop(
const struct wifi_msg_i2c_stop_rsp_t * msg
)
BGScript Functions
call i2c_stop(endpoint)(result)
Bluegiga – A Silicon Labs Company
Page 176 of 236
5.8 Wired Ethernet--Wi-Fi
This class contains commands related to the RMII (Ethernet) interface of the Wi-Fi module.
5.8.1 Commands--Ethernet--Wi-Fi
These commands are related to wired Ethernet.
Connected
This command can be used to test wired Ethernet connection.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x00
lolen
Minimum payload length
2
0x0A
class
Message class: Wired Ethernet
3
0x02
method
Message ID
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x01
lolen
Minimum payload length
2
0x0A
class
Message class: Wired Ethernet
3
0x02
method
Message ID
4
uint8
state
Ethernet cable status
0: Cable is not connected
1: Cable is connected
C Functions
/* Function */
void wifi_cmd_ethernet_connected(
void
);
/* Callback */
struct wifi_msg_ethernet_connected_rsp_t{
uint8 state
}
void wifi_rsp_ethernet_connected(
const struct wifi_msg_ethernet_connected_rsp_t * msg
)
BGScript Functions
call ethernet_connected()(state)
Bluegiga – A Silicon Labs Company
Page 177 of 236
Set Dataroute
This command can be used to configure the Ethernet interface's data route and functionality mode.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x01
lolen
Minimum payload length
2
0x0A
class
Message class: Wired Ethernet
3
0x00
method
Message ID
4
uint8
route
0 : Off
Ethernet interface is off and the link is down.
1 : Bridge
Module is transparent Ethernet - Wi-Fi bridge mode and all data is routed from
Ethernet to Wi-Fi and vice versa and it will bypass the built in IP stack.
Before enabling this setting you must first connect a Wi-Fi network in client (STA)
mode.
2 : Ethernet server
Ethernet is connected to the module's built-in IP stack. And the built-in DHCP and
HTTP servers, as well as TCP and UDP endpoints accessible via Ethernet.
Before enabling this this setting, module must be configured into a Wi-Fi access
point (AP) mode. However when this command is entered Wi-Fi is disabled and
Ethernet used instead.
3 : Ethernet device
In this mode the Ethernet can be used as a client to connect to a network instead of
Wi-Fi. When this command is entered the Wi-Fi radio is disabled.
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x0A
class
Message class: Wired Ethernet
3
0x00
method
Message ID
4-5
uint16
result
Result code
0: success
Non-zero: an error occurred
For other values refer to the error code documentation
Table: EVENTS
event
Description
ethernet_link_status
Sent when Ethernet link status changes
C Functions
Bluegiga – A Silicon Labs Company
Page 178 of 236
/* Function */
void wifi_cmd_ethernet_set_dataroute(
uint8 route
);
/* Callback */
struct wifi_msg_ethernet_set_dataroute_rsp_t{
uint16 result
}
void wifi_rsp_ethernet_set_dataroute(
const struct wifi_msg_ethernet_set_dataroute_rsp_t * msg
)
BGScript Functions
call ethernet_set_dataroute(route)(result)
Bluegiga – A Silicon Labs Company
Page 179 of 236
Close
This command can be used to close the wired Ethernet connection.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x00
lolen
Minimum payload length
2
0x0A
class
Message class: Wired Ethernet
3
0x01
method
Message ID
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x00
lolen
Minimum payload length
2
0x0A
class
Message class: Wired Ethernet
3
0x01
method
Message ID
C Functions
/* Function */
void wifi_cmd_ethernet_close(
void
);
/* Callback *
void wifi_rsp_ethernet_close(
const void *nul
)
BGScript Functions
call ethernet_close()
Bluegiga – A Silicon Labs Company
Page 180 of 236
5.8.2 Events--Ethernet--Wi-Fi
These events are related to the wired Ethernet.
Link Status
This event indicates the status changes of Ethernet link state.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x01
lolen
Minimum payload length
2
0x0A
class
Message class: Wired Ethernet
3
0x00
method
Message ID
4
uint8
state
Link state
0: link is down
1: link is up
C Functions
/* Callback */
struct wifi_msg_ethernet_link_status_evt_t{
uint8 state
}
void wifi_evt_ethernet_link_status(
const struct wifi_msg_ethernet_link_status_evt_t * msg
)
BGScript Functions
event ethernet_link_status(state)
Bluegiga – A Silicon Labs Company
Page 181 of 236
5.9 HTTP Server--Wi-Fi
This class contains commands related to Web server activation and management.
5.9.1 Commands--HTTPS--Wi-Fi
These commands are related to the HTTP server.
Add Path--HTTPS--Wi-Fi
This command can be esed to add a mapping between an HTTP server URL and a storage device.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x09
class
Message class: HTTP Server
3
0x01
method
Message ID
4
uint8
device
Storage device type
0 : Built-in flash
1 : BGAPI
2 : SD card
5
uint8array
path
Server path (URL)
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x09
class
Message class: HTTP Server
3
0x01
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero: an error occurred
For other values refer to the error code documentation
C Functions
/* Function */
void wifi_cmd_https_add_path(
uint8 device,
uint8 path_len,
const uint8* path_data
);
/* Callback */
struct wifi_msg_https_add_path_rsp_t{
uint16 result
}
void wifi_rsp_https_add_path(
const struct wifi_msg_https_add_path_rsp_t * msg
Bluegiga – A Silicon Labs Company
Page 182 of 236
)
BGScript Functions
call https_add_path(device, path_len, path_data)(result)
Bluegiga – A Silicon Labs Company
Page 183 of 236
API Response Finish--HTTPS--Wi-Fi
This command can be used to signal that all HTTP response data has been sent and that the pending HTTP
request can be closed.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x04
lolen
Minimum payload length
2
0x09
class
Message class: HTTP Server
3
0x03
method
Message ID
4-7
uint32
request
Request number
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x09
class
Message class: HTTP Server
3
0x03
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
C Functions
/* Function */
void wifi_cmd_https_api_response_finish(
uint32 request
);
/* Callback */
struct wifi_msg_https_api_response_finish_rsp_t{
uint16 result
}
void wifi_rsp_https_api_response_finish(
const struct wifi_msg_https_api_response_finish_rsp_t * msg
)
BGScript Functions
call https_api_response_finish(request)(result)
Bluegiga – A Silicon Labs Company
Page 184 of 236
API Response--HTTPS--Wi-Fi
This command can be used to send HTTP response data to a pending HTTP request.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x05
lolen
Minimum payload length
2
0x09
class
Message class: HTTP Server
3
0x02
method
Message ID
4-7
uint32
request
Request number
8
uint8array
data
Response data
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x09
class
Message class: HTTP Server
3
0x02
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
C Functions
/* Function */
void wifi_cmd_https_api_response(
uint32 request,
uint8 data_len,
const uint8* data_data
);
/* Callback */
struct wifi_msg_https_api_response_rsp_t{
uint16 result
}
void wifi_rsp_https_api_response(
const struct wifi_msg_https_api_response_rsp_t * msg
)
BGScript Functions
call https_api_response(request, data_len, data_data)(result)
Bluegiga – A Silicon Labs Company
Page 185 of 236
Enable--HTTPS--Wi-Fi
This command can be used to enable or disable built-in HTTP, DHCP or DNS servers.
When the DHCP server is started, the IP address pool for the clients will start with the IP address previously
defined in the PS-key called FLASH_PS_KEY_DHCPS_SPACE, while the subnet mask will always be
configured to 255.255.255.0 Lease time is fixed to 86400s.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x03
lolen
Minimum payload length
2
0x09
class
Message class: http server
3
0x00
method
Message ID
4
uint8
https
Enable/disable HTTP server
0: Disable
1: Enable
5
uint8
dhcps
Enable/disable DHCP server
0: Disable
1: Enable
6
uint8
dnss
Enable/disable DNS server
0: Disable
1: Enable
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x09
class
Message class: http server
3
0x00
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
C Functions
/* Function */
void wifi_cmd_https_enable(
uint8 https,
uint8 dhcps,
uint8 dnss
);
/* Callback */
Bluegiga – A Silicon Labs Company
Page 186 of 236
struct wifi_msg_https_enable_rsp_t{
uint16 result
}
void wifi_rsp_https_enable(
const struct wifi_msg_https_enable_rsp_t * msg
)
BGScript Functions
call https_enable(https, dhcps, dnss)(result)
Bluegiga – A Silicon Labs Company
Page 187 of 236
5.9.2 Events--HTTPS--Wi-Fi
These events are related to the HTTP server.
API Request Data--HTTPS--Wi-Fi
This event includes HTTP payload data for a particular HTTP request. Multiple events may be generated.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x05
lolen
Minimum payload length
2
0x09
class
Message class: HTTP Server
3
0x04
method
Message ID
4-7
uint32
request
Request number
8
uint8array
data
Request data
C Functions
/* Callback */
struct wifi_msg_https_api_request_data_evt_t{
uint32 request,
uint8 data_len,
const uint8* data_data
}
void wifi_evt_https_api_request_data(
const struct wifi_msg_https_api_request_data_evt_t * msg
)
BGScript Functions
event https_api_request_data(request, data_len, data_data)
Bluegiga – A Silicon Labs Company
Page 188 of 236
API Request Finished--HTTPS--Wi-Fi
This event indicates that all HTTP header and payload data has been delivered for a particular HTTP request.
The HTTP request is left pending until API Response Finish has been called or an timeout occurs.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x04
lolen
Minimum payload length
2
0x09
class
Message class: HTTP Server
3
0x05
method
Message ID
4-7
uint32
request
Request number
C Functions
/* Callback */
struct wifi_msg_https_api_request_finished_evt_t{
uint32 request
}
void wifi_evt_https_api_request_finished(
const struct wifi_msg_https_api_request_finished_evt_t * msg
)
BGScript Functions
event https_api_request_finished(request)
Bluegiga – A Silicon Labs Company
Page 189 of 236
API Request Header--HTTPS--Wi-Fi
This event includes HTTP header data for a particular HTTP request. Multiple events may be generated.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x05
lolen
Minimum payload length
2
0x09
class
Message class: HTTP Server
3
0x03
method
Message ID
4-7
uint32
request
Request number
8
uint8array
data
Request header data
C Functions
/* Callback */
struct wifi_msg_https_api_request_header_evt_t{
uint32 request,
uint8 data_len,
const uint8* data_data
}
void wifi_evt_https_api_request_header(
const struct wifi_msg_https_api_request_header_evt_t * msg
)
BGScript Functions
event https_api_request_header(request, data_len, data_data)
Bluegiga – A Silicon Labs Company
Page 190 of 236
API Request--HTTPS--Wi-Fi
This event is received when an HTTP request has been directed to BGAPI. Request number is a unique
identification that it is used for all subsequent events for this particular request. Any response commands to this
request must include the same number.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x06
lolen
Minimum payload length
2
0x09
class
Message class: HTTP Server
3
0x02
method
Message ID
4-7
uint32
request
Request number
8
uint8
method
Request method
0: GET
1: PUT
2: POST
3: DELETE
9
uint8array
resource
Request resource
C Functions
/* Callback */
struct wifi_msg_https_api_request_evt_t{
uint32 request,
uint8 method,
uint8 resource_len,
const uint8* resource_data
}
void wifi_evt_https_api_request(
const struct wifi_msg_https_api_request_evt_t * msg
)
BGScript Functions
event https_api_request(request, method, resource_len, resource_data)
Bluegiga – A Silicon Labs Company
Page 191 of 236
5.10 Persistent Store--Wi-Fi
This class contains commands related to non-volatile memory. These commands can be used to read, write
and dump the local devices parameters (PS keys).
4kB of flash is reserved for Persistent Store.
PS Key IDs over 0x8000 can be used for storing user data.
Flash endurance limits the total written data into PS to 4MB.
5.10.1 Commands--Flash--Wi-Fi
These commands are related to the Persistent Store.
PS Save--Flash--Wi-Fi
This command can be used to store a value into the given PS (Persistent Store) key. This command can be
used to store user data into the Wi-Fi module flash memory, so that the data remains available across resets
and power cycles.
The maximum size of a single PS-key is 255 bytes and a total of 128 keys are available. There is 4KB of
reserved space in total for all PS-Keys.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x03
lolen
Minimum payload length
2
0x07
class
Message class: Persistent Store
3
0x03
method
Message ID
4-5
uint16
key
Key index
Keys 8000 to 807F can be used
for persistent storage of user data.
6
uint8array
value
Key value
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x07
class
Message class: Persistent Store
3
0x03
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
Bluegiga – A Silicon Labs Company
Page 192 of 236
Table: EVENTS
event
Description
flash_ps_key_changed
Sent when a PS key changes
C Functions
/* Function */
void wifi_cmd_flash_ps_save(
uint16 key,
uint8 value_len,
const uint8* value_data
);
/* Callback */
struct wifi_msg_flash_ps_save_rsp_t{
uint16 result
}
void wifi_rsp_flash_ps_save(
const struct wifi_msg_flash_ps_save_rsp_t * msg
)
BGScript Functions
call flash_ps_save(key, value_len, value_data)(result)
Bluegiga – A Silicon Labs Company
Page 193 of 236
PS Load--Flash--Wi-Fi
This command can be used to retrieve the value of the given PS key from the Persistent Store.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x07
class
Message class: Persistent Store
3
0x04
method
Message ID
4-5
uint16
key
Key index to load
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x03
lolen
Minimum payload length
2
0x07
class
Message class: Persistent Store
3
0x04
method
Message ID
4-5
uint16
result
Result code
0: success
Non-zero: an error occurred
Example:
0x0186: Unspecified error, when trying to read a non-existent key
For other values refer to the error code documentation
6
uint8array
value
Key value, i.e. the data stored
C Functions
/* Function */
void wifi_cmd_flash_ps_load(
uint16 key
);
/* Callback */
struct wifi_msg_flash_ps_load_rsp_t{
uint16 result,
uint8 value_len,
const uint8* value_data
}
void wifi_rsp_flash_ps_load(
const struct wifi_msg_flash_ps_load_rsp_t * msg
)
BGScript Functions
call flash_ps_load(key)(result, value_len, value_data)
Bluegiga – A Silicon Labs Company
Page 194 of 236
PS Dump--Flash--Wi-Fi
This command can be used to dump all the PS keys from the Persistent Store. The command will generate a
series of PS key events. The last PS key event is identified by the key index value 65535, indicating that the
dump has finished listing all PS keys.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x00
lolen
Minimum payload length
2
0x07
class
Message class: Persistent Store
3
0x01
method
Message ID
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x07
class
Message class: Persistent Store
3
0x01
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
Table: EVENTS
Event
Description
flash ps_key
PS Key contents
C Functions
/* Function */
void wifi_cmd_flash_ps_dump(
void
);
/* Callback */
struct wifi_msg_flash_ps_dump_rsp_t{
uint16 result
}
void wifi_rsp_flash_ps_dump(
const struct wifi_msg_flash_ps_dump_rsp_t * msg
)
BGScript Functions
call flash_ps_dump()(result)
Bluegiga – A Silicon Labs Company
Page 195 of 236
PS Defrag--Flash--Wi-Fi
This command can be used to manually initiate the defragmentation of the Persistent Store. Persistent store is
also automatically defragmented if there is not enough space.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x00
lolen
Minimum payload length
2
0x07
class
Message class: Persistent Store
3
0x00
method
Message ID
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x07
class
Message class: Persistent Store
3
0x00
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
C Functions
/* Function */
void wifi_cmd_flash_ps_defrag(
void
);
/* Callback */
struct wifi_msg_flash_ps_defrag_rsp_t{
uint16 result
}
void wifi_rsp_flash_ps_defrag(
const struct wifi_msg_flash_ps_defrag_rsp_t * msg
)
BGScript Functions
call flash_ps_defrag()(result)
Bluegiga – A Silicon Labs Company
Page 196 of 236
PS Erase--Flash--Wi-Fi
This command can be used to erase a single PS key and its value from the Persistent Store.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x07
class
Message class: Persistent Store
3
0x05
method
Message ID
4-5
uint16
key
Key index to erase
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x07
class
Message class: Persistent Store
3
0x05
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
Table: EVENTS
event
Description
flash_ps_key_changed
Sent when a PS key changes
C Functions
/* Function */
void wifi_cmd_flash_ps_erase(
uint16 key
);
/* Callback */
struct wifi_msg_flash_ps_erase_rsp_t{
uint16 result
}
void wifi_rsp_flash_ps_erase(
const struct wifi_msg_flash_ps_erase_rsp_t * msg
)
BGScript Functions
call flash_ps_erase(key)(result)
Bluegiga – A Silicon Labs Company
Page 197 of 236
PS Erase All--Flash--Wi-Fi
This command can be used to erase all PS keys from the Persistent Store.
This command will erase the MAC address of the device!
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x00
lolen
Minimum payload length
2
0x07
class
Message class: Persistent Store
3
0x02
method
Message ID
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x07
class
Message class: Persistent Store
3
0x02
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
Table: EVENTS
event
Description
flash_ps_key_changed
Sent when a PS key changes
C Functions
/* Function */
void wifi_cmd_flash_ps_erase_all(
void
);
/* Callback */
struct wifi_msg_flash_ps_erase_all_rsp_t{
uint16 result
}
void wifi_rsp_flash_ps_erase_all(
const struct wifi_msg_flash_ps_erase_all_rsp_t * msg
)
BGScript Functions
call flash_ps_erase_all()(result)
Bluegiga – A Silicon Labs Company
Page 198 of 236
5.10.2 Enumerations--Flash--Wi-Fi
These enumerations are related to Persistent Store.
PS_KEYS--Flash--Wi-Fi
These enumerations define keys.
Table: VALUES
Value
(dec)
Name
Description
1
FLASH_PS_KEY_MAC
MAC address
2
FLASH_PS_KEY_IPV4_SETTINGS
3
FLASH_PS_KEY_DNS0_SETTINGS
4
FLASH_PS_KEY_DNS1_SETTINGS
5
FLASH_PS_KEY_MODULE_SERVICE
10
FLASH_PS_KEY_APPL_NUM1
Integer type parameter for application
11
FLASH_PS_KEY_APPL_NUM2
Integer type parameter for application
12
FLASH_PS_KEY_APPL_NUM3
Integer type parameter for application
13
FLASH_PS_KEY_APPL_NUM4
Integer type parameter for application
14
FLASH_PS_KEY_APPL_STR1
String type parameter for application
15
FLASH_PS_KEY_APPL_STR2
String type parameter for application
16
FLASH_PS_KEY_APPL_STR3
String type parameter for application
17
FLASH_PS_KEY_APPL_STR4
String type parameter for application
18
FLASH_PS_KEY_APPL_TITLE
Web page title
20
FLASH_PS_KEY_AP_SSID
Access point SSID
21
FLASH_PS_KEY_AP_CHANNEL
Access point Wi-Fi channel number
22
FLASH_PS_KEY_AP_PW
Access point encryption password
23
FLASH_PS_KEY_AP_WIFI_N
Access point IEEE 802.11n enabled
24
FLASH_PS_KEY_AP_SECURITY
Access point secure mode 0=Open, 1=WPA,
2=WPA2, 3=WEP, 4=WPA2 mixed
25
FLASH_PS_KEY_CLIENT_SSID
Client SSID
26
FLASH_PS_KEY_CLIENT_PW
Client encryption password
30
FLASH_PS_KEY_DHCPS_ENABLE
DHCP server enable
31
FLASH_PS_KEY_DHCPS_SPACE
DHCP server first address of IPv4 address space, as
4 byte integer (Subnet mask is fixed to
255.255.255.0)
35
FLASH_PS_KEY_DNSS_ENABLE
DNS server enable
36
FLASH_PS_KEY_DNSS_URL
DNS server URL
37
FLASH_PS_KEY_DNSS_ANY_URL
DNS server reply to any URL enabled
40
FLASH_PS_KEY_AP_SCANLIST_ITEM_1
Access point found in client scan
Bluegiga – A Silicon Labs Company
Page 199 of 236
Value
(dec)
Name
Description
41
FLASH_PS_KEY_AP_SCANLIST_ITEM_2
Access point found in client scan
42
FLASH_PS_KEY_AP_SCANLIST_ITEM_3
Access point found in client scan
43
FLASH_PS_KEY_AP_SCANLIST_ITEM_4
Access point found in client scan
44
FLASH_PS_KEY_AP_SCANLIST_ITEM_5
Access point found in client scan
45
FLASH_PS_KEY_AP_SCANLIST_ITEM_6
Access point found in client scan
46
FLASH_PS_KEY_AP_SCANLIST_ITEM_7
Access point found in client scan
47
FLASH_PS_KEY_AP_SCANLIST_ITEM_8
Access point found in client scan
48
FLASH_PS_KEY_AP_SCANLIST_ITEM_9
Access point found in client scan
49
FLASH_PS_KEY_AP_SCANLIST_ITEM_10
Access point found in client scan
50
FLASH_PS_KEY_AP_LABEL1
Text of label in webpage
51
FLASH_PS_KEY_AP_LABEL2
Text of label in webpage
52
FLASH_PS_KEY_AP_LABEL3
Text of label in webpage
53
FLASH_PS_KEY_AP_LABEL4
Text of label in webpage
54
FLASH_PS_KEY_AP_LABEL5
Text of label in webpage
55
FLASH_PS_KEY_AP_LABEL6
Text of label in webpage
56
FLASH_PS_KEY_AP_LABEL7
Text of label in webpage
57
FLASH_PS_KEY_AP_LABEL8
Text of label in webpage
58
FLASH_PS_KEY_AP_LABEL9
Text of label in webpage
59
FLASH_PS_KEY_AP_LABEL10
Text of label in webpage
Bluegiga – A Silicon Labs Company
Page 200 of 236
5.10.3 Events--Flash--Wi-Fi
These events are related to Persistent Store.
Low Voltage--Flash--Wi-Fi
These events indicate that a low voltage state was detected during Flash operation. Flash writing is not
possible.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x00
lolen
Minimum payload length
2
0x07
class
Message class: Persistent Store
3
0x02
method
Message ID
C Functions
/* Callback */
void wifi_evt_flash_low_voltage(
const void *nul
)
BGScript Functions
event flash_low_voltage()
Bluegiga – A Silicon Labs Company
Page 201 of 236
PS Key Changed--Flash--Wi-Fi
This event indicates that a PS key has been changed.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x02
lolen
Minimum payload length
2
0x07
class
Message class: Persistent Store
3
0x01
method
Message ID
4-5
uint16
key
Key index
C Functions
/* Callback */
struct wifi_msg_flash_ps_key_changed_evt_t{
uint16 key
}
void wifi_evt_flash_ps_key_changed(
const struct wifi_msg_flash_ps_key_changed_evt_t * msg
)
BGScript Functions
event flash_ps_key_changed(key)
Bluegiga – A Silicon Labs Company
Page 202 of 236
PS Key--Flash--Wi-Fi
This event is generated when PS keys are dumped from the Persistent Store.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x03
lolen
Minimum payload length
2
0x07
class
Message class: Persistent Store
3
0x00
method
Message ID
4-5
uint16
key
Key index
65535 : Last key
6
uint8array
value
Key value
C Functions
/* Callback */
struct wifi_msg_flash_ps_key_evt_t{
uint16 key,
uint8 value_len,
const uint8* value_data
}
void wifi_evt_flash_ps_key(
const struct wifi_msg_flash_ps_key_evt_t * msg
)
BGScript Functions
event flash_ps_key(key, value_len, value_data)
Bluegiga – A Silicon Labs Company
Page 203 of 236
5.11 Device Firmware Upgrade--Wi-Fi
This class contains commands related to firmware update. The commands and corresponding events in this
class are available only when the device has been booted into DFU mode.
5.11.1 Commands--DFU--Wi-Fi
These commands relate to Device Firmware Upgrade.
Reset--DFU--Wi-Fi
This command resets the Wi-Fi module. This command does not have a response, but triggers one of the boot
events after re-boot.
The DFU process:
1.
2.
3.
4.
5.
6.
Boot device to DFU mode with Reset command.
Wait for DFU boot event.
Send command Flash Set Address to start the firmware update.
Upload the firmware with Flash Upload commands until all the data has been uploaded.
Send Flash Upload Finish to when all the data has been uploaded.
Finalize the DFU firmware update with Reset command.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x01
lolen
Minimum payload length
2
0x00
class
Message class: Device Firmware Upgrade
3
0x00
method
Message ID
4
uint8
dfu
Boot mode
0: Normal reset
1: Boot to DFU mode
Table: EVENTS
event
Description
system_boot
Sent after the device has booted to normal mode
dfu_boot
Sent after the device has booted to DFU mode
C Functions
/* Function */
void wifi_cmd_dfu_reset(
uint8 dfu
);
BGScript Functions
call dfu_reset(dfu)
Bluegiga – A Silicon Labs Company
Page 204 of 236
Flash Set Address--DFU--Wi-Fi
This command can be used after re-booting the Wi-Fi module into DFU mode and it sets the starting address on
the Flash from where onwards the new firmware data will be written into.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x04
lolen
Minimum payload length
2
0x00
class
Message class: Device Firmware Upgrade
3
0x01
method
Message ID
4-7
uint32
address
The offset in the Flash where to start flashing.
Use the value 0x0000
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x00
class
Message class: Device Firmware Upgrade
3
0x01
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
C Functions
/* Function */
void wifi_cmd_dfu_flash_set_address(
uint32 address
);
/* Callback */
struct wifi_msg_dfu_flash_set_address_rsp_t{
uint16 result
}
void wifi_rsp_dfu_flash_set_address(
const struct wifi_msg_dfu_flash_set_address_rsp_t * msg
)
BGScript Functions
call dfu_flash_set_address(address)(result)
Bluegiga – A Silicon Labs Company
Page 205 of 236
Flash Upload--DFU--Wi-Fi
This command can be used to upload the firmware update file to the Wi-Fi Module. The payload of the data in
this command is 128 bytes, so multiple commands need to be used to upload the full firmware update file.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x01
lolen
Minimum payload length
2
0x00
class
Message class: Device Firmware Upgrade
3
0x02
method
Message ID
4
uint8array
data
An array of 128B of data which will be written into the Flash.
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x00
class
Message class: Device Firmware Upgrade
3
0x02
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
C Functions
/* Function */
void wifi_cmd_dfu_flash_upload(
uint8 data_len,
const uint8* data_data
);
/* Callback */
struct wifi_msg_dfu_flash_upload_rsp_t{
uint16 result
}
void wifi_rsp_dfu_flash_upload(
const struct wifi_msg_dfu_flash_upload_rsp_t * msg
)
BGScript Functions
call dfu_flash_upload(data_len, data_data)(result)
Bluegiga – A Silicon Labs Company
Page 206 of 236
Flash Upload Finish--DFU--Wi-Fi
This command can be used to tell the device that the DFU file has been fully uploaded. Next the user should
issue the DFU Reset command to return the device back into normal mode.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x00
lolen
Minimum payload length
2
0x00
class
Message class: Device Firmware Upgrade
3
0x03
method
Message ID
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x00
class
Message class: Device Firmware Upgrade
3
0x03
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
C Functions
/* Function */
void wifi_cmd_dfu_flash_upload_finish(
void
);
/* Callback */
struct wifi_msg_dfu_flash_upload_finish_rsp_t{
uint16 result
}
void wifi_rsp_dfu_flash_upload_finish(
const struct wifi_msg_dfu_flash_upload_finish_rsp_t * msg
)
BGScript Functions
call dfu_flash_upload_finish()(result)
Bluegiga – A Silicon Labs Company
Page 207 of 236
5.11.2 Events--DFU--Wi-Fi
These events are related to Device Firmware Upgrade.
Boot--DFU--Wi-Fi
This event indicates that the module booted in DFU mode, and that the module is ready to receive commands
related to DFU firmware upgrade.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x04
lolen
Minimum payload length
2
0x00
class
Message class: Device Firmware Upgrade
3
0x00
method
Message ID
4-7
uint32
version
The version of the bootloader
C Functions
/* Callback */
struct wifi_msg_dfu_boot_evt_t{
uint32 version
}
void wifi_evt_dfu_boot(
const struct wifi_msg_dfu_boot_evt_t * msg
)
BGScript Functions
event dfu_boot(version)
Bluegiga – A Silicon Labs Company
Page 208 of 236
5.12 Utilities for BGScript--Wi-Fi
This class contains commands related to BGScript programming language utilities.
5.12.1 Commands--Util--Wi-Fi
These commands are utility functions for using BGScript commands.
AtoI--Util--Wi-Fi
This command can be used to convert a decimal value from an ASCII string format into a 32-bit signed integer
format.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x01
lolen
Minimum payload length
2
0x0D
class
Message class: Utilities for BGScript
3
0x00
method
Message ID
4
uint8array
string
String to convert
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x04
lolen
Minimum payload length
2
0x0D
class
Message class: Utilities for BGScript
3
0x00
method
Message ID
4-7
int32
value
32-bit integer value
C Functions
/* Function */
void wifi_cmd_util_atoi(
uint8 string_len,
const uint8* string_data
);
/* Callback */
struct wifi_msg_util_atoi_rsp_t{
int32 value
}
void wifi_rsp_util_atoi(
const struct wifi_msg_util_atoi_rsp_t * msg
)
BGScript Functions
call util_atoi(string_len, string_data)(value)
Bluegiga – A Silicon Labs Company
Page 209 of 236
ItoA--Util--Wi-Fi
This command can be used to convert a number from signed 32-bit integer format into decimal ASCII value
format.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x04
lolen
Minimum payload length
2
0x0D
class
Message class: Utilities for BGScript
3
0x01
method
Message ID
4-7
int32
value
32-bit integer value to convert
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x01
lolen
Minimum payload length
2
0x0D
class
Message class: Utilities for BGScript
3
0x01
method
Message ID
4
uint8array
string
Converted ASCII string
C Functions
/* Function */
void wifi_cmd_util_itoa(
int32 value
);
/* Callback */
struct wifi_msg_util_itoa_rsp_t{
uint8 string_len,
const uint8* string_data
}
void wifi_rsp_util_itoa(
const struct wifi_msg_util_itoa_rsp_t * msg
)
BGScript Functions
call util_itoa(value)(string_len, string_data)
Bluegiga – A Silicon Labs Company
Page 210 of 236
5.13 SD card--Wi-Fi
This class contains commands related to the Wi-Fi module SD memory card interface.
5.13.1 Commands--SDHC--Wi-Fi
These commands are related with SD/SDHC memory card file system.
Fchdir--SDHC--Wi-Fi
This command can be used to change the active directory.
To get the current active directory, use this command with path value "."
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x01
lolen
Minimum payload length
2
0x0C
class
Message class: SD/SDHC memory card filesystem
3
0x07
method
Message ID
4
uint8array
dir_name
Full path of directory to change
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x0C
class
Message class: SD/SDHC memory card filesystem
3
0x07
method
Message ID
4-5
uint16
result
Result code
0 : success
Non-zero : an error occurred
For other values refer to the error code documentation
Table: EVENTS
Event
Description
sdhc_fpwd
Path of active directory
C Functions
/* Function */
void wifi_cmd_sdhc_fchdir(
uint8 dir_name_len,
const uint8* dir_name_data
);
/* Callback */
Bluegiga – A Silicon Labs Company
Page 211 of 236
struct wifi_msg_sdhc_fchdir_rsp_t{
uint16 result
}
void wifi_rsp_sdhc_fchdir(
const struct wifi_msg_sdhc_fchdir_rsp_t * msg
)
BGScript Functions
call sdhc_fchdir(dir_name_len, dir_name_data)(result)
Bluegiga – A Silicon Labs Company
Page 212 of 236
Fchmode--SDHC--Wi-Fi
This command can be used to change the attributes of a file.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x0C
class
Message class: SD/SDHC memory card filesystem
3
0x09
method
Message ID
4
uint8
value
File or directory attributes.
Values:
0x01: read only
0x02: hidden
0x04: system
5
uint8array
fname
File name
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x0C
class
Message class: SD/SDHC memory card filesystem
3
0x09
method
Message ID
4-5
uint16
result
Result code
0: success
Non-zero: an error occurred
For other values refer to the error code documentation
C Functions
/* Function */
void wifi_cmd_sdhc_fchmode(
uint8 value,
uint8 fname_len,
const uint8* fname_data
);
/* Callback */
struct wifi_msg_sdhc_fchmode_rsp_t{
uint16 result
}
void wifi_rsp_sdhc_fchmode(
const struct wifi_msg_sdhc_fchmode_rsp_t * msg
)
BGScript Functions
call sdhc_fchmode(value,fname_len, fname_data)(result)
Bluegiga – A Silicon Labs Company
Page 213 of 236
Bluegiga – A Silicon Labs Company
Page 214 of 236
Fclose--SDHC--Wi-Fi
This command can be used to close a file.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x01
lolen
Minimum payload length
2
0x0C
class
Message class: SD/SDHC memory card filesystem
3
0x01
method
Message ID
4
uint8
fhandle
Handle of the open file
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x0C
class
Message class: SD/SDHC memory card filesystem
3
0x01
method
Message ID
4-5
uint16
result
Result code
0: success
Non-zero: an error occurred
For other values refer to the error code documentation
C Functions
/* Function */
void wifi_cmd_sdhc_fclose(
uint8 fhandle
);
/* Callback */
struct wifi_msg_sdhc_fclose_rsp_t{
uint16 result
}
void wifi_rsp_sdhc_fclose(
const struct wifi_msg_sdhc_fclose_rsp_t * msg
)
BGScript Functions
call sdhc_fclose(fhandle)(result)
Bluegiga – A Silicon Labs Company
Page 215 of 236
Fdelete--SDHC--Wi-Fi
This command can be used to delete a file or empty directory.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x01
lolen
Minimum payload length
2
0x0C
class
Message class: SD/SDHC memory card filesystem
3
0x05
method
Message ID
4
uint8array
fname
File name with path
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x0C
class
Message class: SD/SDHC memory card filesystem
3
0x05
method
Message ID
4-5
uint16
result
Result code
0: success
Non-zero: an error occurred
For other values refer to the error code documentation
C Functions
/* Function */
void wifi_cmd_sdhc_fdelete(
uint8 fname_len,
const uint8* fname_data
);
/* Callback */
struct wifi_msg_sdhc_fdelete_rsp_t{
uint16 result
}
void wifi_rsp_sdhc_fdelete(
const struct wifi_msg_sdhc_fdelete_rsp_t * msg
)
BGScript Functions
call sdhc_fdelete(fname_len, fname_data)(result)
Bluegiga – A Silicon Labs Company
Page 216 of 236
Fdir--sdhc--WIFI
This command can be used to list files of the current directory. The command also lists files and folders with the
hidden attribute set.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x0C
class
Message class: SD/SDHC memory card filesystem
3
0x02
method
Message ID
4
uint8
mode
File list mode
0: normal
1: recursive
5
uint8array
Path of directory to list
path
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x0C
class
Message class: SD/SDHC memory card filesystem
3
0x02
method
Message ID
4-5
uint16
result
Result code
0: success
Non-zero: an error occurred
For other values refer to the error code documentation
Table: EVENTS
Event
Description
sdhc_ffile
File info
sdhc_ready
Operation ready
C Functions
/* Function */
void wifi_cmd_sdhc_fdir(
uint8 mode,
uint8 path_len,
const uint8* path_data
);
/* Callback */
struct wifi_msg_sdhc_fdir_rsp_t{
uint16 result
}
void wifi_rsp_sdhc_fdir(
const struct wifi_msg_sdhc_fdir_rsp_t * msg
Bluegiga – A Silicon Labs Company
Page 217 of 236
)
BGScript Functions
call sdhc_fdir(mode, path_len, path_data)(result)
Bluegiga – A Silicon Labs Company
Page 218 of 236
Fmkdir--SDHC--Wi-Fi
This command can be used to create a directory.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x01
lolen
Minimum payload length
2
0x0C
class
Message class: SD/SDHC memory card filesystem
3
0x06
method
Message ID
4
uint8array
dir_name
Directory to create
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x0C
class
Message class: SD/SDHC memory card filesystem
3
0x06
method
Message ID
4-5
uint16
result
Result code
0: success
Non-zero: an error occurred
For other values refer to the error code documentation
C Functions
/* Function */
void wifi_cmd_sdhc_fmkdir(
uint8 dir_name_len,
const uint8* dir_name_data
);
/* Callback */
struct wifi_msg_sdhc_fmkdir_rsp_t{
uint16 result
}
void wifi_rsp_sdhc_fmkdir(
const struct wifi_msg_sdhc_fmkdir_rsp_t * msg
)
BGScript Functions
call sdhc_fmkdir(dir_name_len, dir_name_data)(result)
Bluegiga – A Silicon Labs Company
Page 219 of 236
Fopen--SDHC--Wi-Fi
This command can be used to open a file. When you open a file you can set the mode to either read (0x1), write
(0x2) or read/write(0x03).
To create a new file, the new bit (0x08) must be set.
You must open a file before it can be read, written or renamed.
Maximum total length of file name (path + file name) is 254 bytes.
Maximum 10 files can be opened concurrently.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x0C
class
Message class: SD/SDHC memory card filesystem
3
0x00
method
Message ID
4
uint8
mode
Open mode
0x1: read
0x2: write
0x8: create new file
5
uint8array
fname
File name
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x0C
class
Message class: SD/SDHC memory card filesystem
3
0x00
method
Message ID
4-5
uint16
result
Result code
0: success
Non-zero an error occurred
For other values refer to the error code documentation
Table: EVENTS
Event
Description
sdhc_ffile File information.
In the event fattrib value is file open attribute. E.g. read only when file opened as read only, even
file attribute in disk is different.
Bluegiga – A Silicon Labs Company
Page 220 of 236
C Functions
/* Function */
void wifi_cmd_sdhc_fopen(
uint8 mode,
uint8 fname_len,
const uint8* fname_data
);
/* Callback */
struct wifi_msg_sdhc_fopen_rsp_t{
uint16 result
}
void wifi_rsp_sdhc_fopen(
const struct wifi_msg_sdhc_fopen_rsp_t * msg
)
BGScript Functions
call sdhc_fopen(mode, fname_len, fname_data)(result)
Bluegiga – A Silicon Labs Company
Page 221 of 236
Fread--SDHC--Wi-Fi
This command can be used to read data from a file. The read data is sent in multiple sdhc_fdata events each
one containing up to 512 bytes of data.
When a whole file is read, the reading always starts from the beginning of the file.
After a file has been written you must close and reopen it, before you can read it.
To restart a file read process from the beginning you need to close and reopen the file.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x05
lolen
Minimum payload length
2
0x0C
class
Message class: SD/SDHC memory card filesystem
3
0x03
method
Message ID
4
uint8
fhandle
Handle of opened file
5-8
uint32
fsize
Bytes to read
0: read the whole file
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x0C
class
Message class: SD/SDHC memory card filesystem
3
0x03
method
Message ID
4-5
uint16
result
Result code
0: success
Non-zero: an error occurred
For other values refer to the error code documentation
Table: EVENTS
Event
Description
sdhc_fdata
Data
sdhc_ready
Operation ready
C Functions
/* Function */
void wifi_cmd_sdhc_fread(
uint8 fhandle,
uint32 fsize
Bluegiga – A Silicon Labs Company
Page 222 of 236
);
/* Callback */
struct wifi_msg_sdhc_fread_rsp_t{
uint16 result
}
void wifi_rsp_sdhc_fread(
const struct wifi_msg_sdhc_fread_rsp_t * msg
)
BGScript Functions
call sdhc_fread(fhandle, fsize)(result)
Bluegiga – A Silicon Labs Company
Page 223 of 236
Frename--SDHC--Wi-Fi
This command can be used to rename a file in the current directory.
To rename a file:
1. Open the file in the current directory.
2. Rename the file, which will also close the file.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x0C
class
Message class: SD/SDHC memory card filesystem
3
0x08
method
Message ID
4
uint8
fhandle
Handle of opened file
5
uint8array
new_name
File name to change
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x0C
class
Message class: SD/SDHC memory card filesystem
3
0x08
method
Message ID
4-5
uint16
result
Result code
0: success
Non-zero: an error occurred
For other values refer to the error code documentation
C Functions
/* Function */
void wifi_cmd_sdhc_frename(
uint8 fhandle,
uint8 new_name_len,
const uint8* new_name_data
);
/* Callback */
struct wifi_msg_sdhc_frename_rsp_t{
uint16 result
}
void wifi_rsp_sdhc_frename(
const struct wifi_msg_sdhc_frename_rsp_t * msg
)
BGScript Functions
Bluegiga – A Silicon Labs Company
Page 224 of 236
call sdhc_frename(fhandle, new_name_len, new_name_data)(result)
Bluegiga – A Silicon Labs Company
Page 225 of 236
Fwrite--sdhc--WIFI
Write data to a file.
You can write more data to a file by calling this command again, but only after you have received
Ready event. Data will be appended to the end of the file.
Table: COMMAND
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x03
lolen
Minimum payload length
2
0x0C
class
Message class: SD/SDHC memory card filesystem
3
0x04
method
Message ID
4
uint8
fhandle
Handle of opened file
5-6
uint16array
fdata
Data to write
Table: RESPONSE
Byte
Type
Name
Description
0
0x08
hilen
Message type: command
1
0x02
lolen
Minimum payload length
2
0x0C
class
Message class: SD/SDHC memory card filesystem
3
0x04
method
Message ID
4-5
uint16
result
Result code
0: success
Non-zero: an error occurred
For other values refer to the error code documentation
Table: EVENTS
Event
Description
sdhc_ready
Operation ready
C Functions
/* Function */
void wifi_cmd_sdhc_fwrite(
uint8 fhandle,
uint16 fdata_len,
const uint8* fdata_data
);
/* Callback */
struct wifi_msg_sdhc_fwrite_rsp_t{
uint16 result
}
void wifi_rsp_sdhc_fwrite(
const struct wifi_msg_sdhc_fwrite_rsp_t * msg
)
Bluegiga – A Silicon Labs Company
Page 226 of 236
BGScript Functions
call sdhc_fwrite(fhandle, fdata_len, fdata_data)(result)
Bluegiga – A Silicon Labs Company
Page 227 of 236
5.13.2 Events--SDHC--Wi-Fi
These events are related to the SD/SDHC memory card file system.
Fdata--SDHC--Wi-Fi
This event is generated when the content of the data is read with the command Fread. Mutiple events might be
generated based on the file size.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x03
lolen
Minimum payload length
2
0x0C
class
Message class: SD/SDHC memory card filesystem
3
0x01
method
Message ID
4
uint8
fhandle
Handle of opened file
5-6
uint16array
data
Content
C Functions
/* Callback */
struct wifi_msg_sdhc_fdata_evt_t{
uint8 fhandle,
uint16 data_len,
const uint8* data_data
}
void wifi_evt_sdhc_fdata(
const struct wifi_msg_sdhc_fdata_evt_t * msg
)
BGScript Functions
event sdhc_fdata(fhandle, data_len, data_data)
Bluegiga – A Silicon Labs Company
Page 228 of 236
Ffile--SDHC--Wi-Fi
This event contains the file information and is generated in response to commands Fdir or Fopen.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x07
lolen
Minimum payload length
2
0x0C
class
Message class: SD/SDHC memory card filesystem
3
0x02
method
Message ID
4
uint8
fhandle
Handle of opened file, 255=file not opened
5-8
uint32
fsize
File size
9
uint8
fattrib
File attributes
0x01: read only
0x02: hidden
0x04: system
0x10: directory
10
uint8array
fname
File name
C Functions
/* Callback */
struct wifi_msg_sdhc_ffile_evt_t{
uint8 fhandle,
uint32 fsize,
uint8 fattrib,
uint8 fname_len,
const uint8* fname_data
}
void wifi_evt_sdhc_ffile(
const struct wifi_msg_sdhc_ffile_evt_t * msg
)
BGScript Functions
event sdhc_ffile(fhandle, fsize, fattrib, fname_len, fname_data)
Bluegiga – A Silicon Labs Company
Page 229 of 236
Fpwd--SDHC--Wi-Fi
This event is generated when active directory is changed with command Fchdir.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x01
lolen
Minimum payload length
2
0x0C
class
Message class: SD/SDHC memory card filesystem
3
0x03
method
Message ID
4
uint8array
fdir
Full path of active directory
C Functions
/* Callback */
struct wifi_msg_sdhc_fpwd_evt_t{
uint8 fdir_len,
const uint8* fdir_data
}
void wifi_evt_sdhc_fpwd(
const struct wifi_msg_sdhc_fpwd_evt_t * msg
)
BGScript Functions
event sdhc_fpwd(fdir_len, fdir_data)
Bluegiga – A Silicon Labs Company
Page 230 of 236
Ready--SDHC--Wi-Fi
This event indicates that an SD operation has finished.
Table: EVENT
Byte
Type
Name
Description
0
0x88
hilen
Message type: event
1
0x04
lolen
Minimum payload length
2
0x0C
class
Message class: SD/SDHC memory card filesystem
3
0x00
method
Message ID
4
uint8
fhandle
Handle of opened file
5
uint8
operation
Operation which caused the event.
0: card state
1: file read
2: file write
3: file listing
6-7
uint16
result
Result code
0: success
Non-zero: an error occurred
For other values refer to the error code documentation
C Functions
/* Callback */
struct wifi_msg_sdhc_ready_evt_t{
uint8 fhandle,
uint8 operation,
uint16 result
}
void wifi_evt_sdhc_ready(
const struct wifi_msg_sdhc_ready_evt_t * msg
)
BGScript Functions
event sdhc_ready(fhandle, operation, result)
Bluegiga – A Silicon Labs Company
Page 231 of 236
5.14 Error codes -- Wi-Fi
This section of the document describes the error codes produced by the Wi-Fi software.
5.14.1 BGAPI Errors--Wi-Fi
These errors are related to BGAPI protocol issues.
Invalid Parameter (0x0180)--Wi-Fi
This error code indicates that a command contained an invalid parameter
Device in Wrong State (0x0181)--Wi-Fi
This error code indicates that the device is in wrong state to accept commands.
Out Of Memory (0x0182)--Wi-Fi
This error indicates that the device has run out of memory.
Feature Not Implemented (0x0183)--Wi-Fi
This error indicates that the feature in question has not been implemented.
Command Not Recognized (0x0184)--Wi-Fi
This error indicates that the issued command was not recognized.
Timeout (0x0185)--Wi-Fi
This error indicates that a command or procedure failed due to timeout.
This error code is generated e.g. if you send an incomplete command to the Wi-Fi module - after the timeout of
1 second this error code is sent to the host transported by the event endpoint_syntax_error.
This error code is generated also e.g. when the maximum number of retry attempts (10) to try to connect to a
wireless network have been executed. A typical example of such a case might be when the issued password is
invalid, in which case the error code is transported by the event wifi_evt_sme_connect_failed.
Unspecified error (0x0186)--Wi-Fi
This error code is generated when an unspecified error is detected.
Hardware failure (0x0187)--Wi-Fi
This error code is generated when a hardware failure is detected.
Internal buffers are full (0x0188)--Wi-Fi
This error code is generated the a command was not accepted due to full internal buffers.
Disconnected (0x0189)--Wi-Fi
This error code is generated when a command or procedure has failed due to disconnection.
Too many requests (0x018A)--Wi-Fi
This error code is generated when there are too many simultaneous requests.
Bluegiga – A Silicon Labs Company
Page 232 of 236
Access Point not in scanlist (0x018B)--Wi-Fi
This error code is generated when the defined Access Point is not found from the scanlist.
Invalid password (0x018C)--Wi-Fi
This error code is generated in the following cases:
1) you try to connect to a secured network without setting the password or the password is too short
2) you try to start a secured AP without setting the password or the password is too short
3) you try to set a 64-character PSK with non-hex characters
4) you try to set an invalid WEP key (invalid characters or invalid length)
Notice that WPA does not contain any standard way for the Access Point to communicate to the station that the
password is invalid. The Access Point just disconnects the client during authentication if the password is found
invalid. Some stations take an educated guess that this probably means the password is incorrect. WF121
simply retries the authentication until it exceeds the maximum amount of retries (10) which then causes the
0x0185 Timeout Error.
Authentication failure (0x018D)--Wi-Fi
This error code is generated when the WPA/WPA2 authentication has failed.
Overflow (0x018E)--Wi-Fi
This error code is generated when an overflow has been detected.
Multiple PBC sessions (0x018F)--Wi-Fi
This error code is generated when multiple PBC (Push Button Configuration) sessions have been detected.
Ethernet not connected (0x0190)--Wi-Fi
This error code is generated when the Ethernet cable is not connected.
Ethernet route not set (0x0191)--Wi-Fi
This error code is generated if the Ethernet route is not set.
Wrong operating mode (0x0192)--Wi-Fi
This error code is generated if the operating mode is wrong for the issued command.
Not found (0x0193)--Wi-Fi
This error code is generated if the requested resource was not found.
Already exists (0x0194)--Wi-Fi
This error is generated if the requested resource already exists.
Invalid configuration (0x0195)--Wi-Fi
This error code is generated if the current configuration is invalid.
Access Point lost (0x0196)--Wi-Fi
This error code is generated if the connection to an Access Point is lost.
5.14.2 Hardware Errors--Wi-Fi
These errors are related to hardware issues.
Bluegiga – A Silicon Labs Company
Page 233 of 236
PS Store is full (0x0301)--Wi-Fi
This error is generated if the Flash which is reserved for the PS (Persistent Store) is full.
PS key not found (0x0302)--Wi-Fi
This error is generated if the PS key (Persistent Store key) was not found.
I2C write already in progress (0x0303)--Wi-Fi
This error is generated if I2C transmission was initiated while a transmission was already in progress.
I2C ack missing (0x0304)--Wi-Fi
This error is generated if an acknowledgement for I2C was not received.
Flash write failed (0x0308)--Wi-Fi
This error code is generated if writing to Flash failed.
File not opened (0x0305)--Wi-Fi
This error code is generated if an access was attempted to an unopened file.
File not found (0x0306)--Wi-Fi
This error code is generated if the requested file was not found in the SD card.
Disk error (0x0307)--Wi-Fi
This error code is generated if an SD card error was detected of if the SD card is full.
5.14.3 TCP/IP Errors--Wi-Fi
These errors are related to TCP/IP stack issues.
Success (0x0200)--Wi-Fi
This code indicates that no error was detected.
Out of memory (0x0201)--Wi-Fi
This error code is generated when the system has run out of memory.
Buffer error (0x0202)--Wi-Fi
This error code is generated when handling of buffers has failed.
Timeout (0x0203)--Wi-Fi
This error code is generated when a timeout has been detected.
Routing (0x0204)--Wi-Fi
This error code is generated when a route could not be found.
In progress (0x0205)--Wi-Fi
This error code is generated when an operation is in progress.
Illegal_value (0x0206)--Wi-Fi
This error code is generated when the issued value is deemed illegal.
Bluegiga – A Silicon Labs Company
Page 234 of 236
Would_block (0x0207)--WIFI
This error code is generated when an operation blocks.
Address in use (0x0208)--Wi-Fi
This error code is generated when the issued address is already in use.
Already connected (0x0209)--Wi-Fi
This error code is generated when the Wi-Fi module is already connected.
Connection aborted (0x020A)--Wi-Fi
This error code is generated when a connection is aborted.
Connection reset (0x020B)--Wi-Fi
This error code is generated when a connection has been reset.
Connection closed (0x020C)--Wi-Fi
This error code is generated when a connection has been closed.
Not connected (0x020D)--Wi-Fi
This error code is generated when the Wi-Fi module is not connected.
Illegal argument (0x020E)--Wi-Fi
This error code is generated if an illegal argument was issued.
Interface level error (0x020F)--Wi-Fi
This error code is generated if an interface error was detected.
Unknown host (0x0280)--Wi-Fi
This error is generated if an unknown host is detected.
Service not running (0x0210)--Wi-Fi
This error code is generated if the specified service is not running.
Service running (0x0211)--Wi-Fi
This error code is generated if the specified service is already running.
Hostname not set (0x0212)--Wi-Fi
This error code is generated if the hostname has not been set.
Hostname conflict (0x0213)--Wi-Fi
This error code is generated if a hostname conflict was detected.
Bluegiga – A Silicon Labs Company
Page 235 of 236
Contact information
Sales:
www.bluegiga.com
Technical support:
http://www.bluegiga.com/support/
Orders:
[email protected]
WWW:
http://www.bluegiga.com
SILICON LABS
Phone: +1 877.444.3032
400 West Cesar Chavez
Austin, TX 78701 USA
FINLAND OFFICE
Phone: +358 9 435 5060
Fax: +358 9 435 50660
Sinikalliontie 5A, 5th floor
02630 Espoo, Finland
Bluegiga – A Silicon Labs Company
Page 236 of 236
Similar pages