Wi-SUN Docs
Preliminary
Toggle navigation
Nav
Version
Get started
Step 1 - Requirements
Step 2 - Register your kit
Step 3 - Set up the hardware
Step 4 - Install the software
Step 5 - Configure the Wi-SUN devices
Step 6 - Explore the Wi-SUN network in action
1. Verify Wi-SUN network communication
2. Run edge intelligence examples
3. Evaluate the Border Router’s routing capabilities
4. Experiment with network parameters
Step 7 - Connect to the cloud
Step 8 - Recap and solidify
Next steps
Reference material
API Frames
User Data Relay
User Data Relay Input - 0x2D
User Data Relay Output - 0xAD
Configuration
Local AT Command Request - 0x08
Queue Local AT Command Request - 0x09
IPv6 XBee Services Request - 0x19
Local AT Command Response - 0x88
IPv6 Remote Command - 0x1B
IPv6 Remote Command Response - 0x9B
Communication
TX Request Message - 0x1A
Socket Create - 0x40
Socket Option Request - 0x41
Socket Connect - 0x42
Socket Close - 0x43
Socket Send (Transmit) - 0x44
Socket Bind/Listen - 0x46
Socket SendTo (Transmit Explicit Data) - 0x47
Socket Create Response - 0xC0
Connection Response - 0xC1
Socket Close Response - 0xC2
Socket Close Response - 0xC3
Socket Listen Response - 0xC6
Socket New IPv6 Client - 0xCA
Socket Receive From - IPv6 - 0xCB
Socket Receive - 0xCD
Socket State - 0xCF
Status
Transmit Status - 0x89
Modem Status - 0x8A
I/O Sampling
IO Sample Indicator - 0xA7
File System
Local File System Request - 0x3B
File Open - 0x01
File Close - 0x02
File Read - 0x03
File Write - 0x04
File Hash - 0x08
Directory Create - 0x10
Directory Open - 0x11
Directory Close - 0x12
Directory Read - 0x13
Get Path ID - 0x1C
Delete - 0x2F
Volume Info - 0x40
Volume Format - 0x4F
Local File System Response - 0xBB
Remote File System IPv6 Request - 0x53
Remote File System IPv6 Response - 0xD3
AT commands
Networking
AI (Association Indication)
CE (Routing/Messaging Mode)
DO (Device Options)
IP (Transmission Protocol)
JN (Join Network)
LN (Leave Network)
NI (Node Identifier)
PB (Ping Payload Size)
PG (Ping Command)
PI (Ping Timeout)
RN (Reset Network Credential Cache)
WC (Channel Plan)
WM (PHY Mode)
WN (Network Name)
WS (Network Size)
Addressing
C0 (Source Port)
DE (Destination Port)
DL (Destination Address)
MB (IPv6 Border Router Network Address)
ML (IPv6 Link Local Network Address)
MP (IPv6 Primary Parent Network Address)
MS (IPv6 Global Secondary Parent Address)
MY (IPv6 Global Network Address)
SH (Serial Number High)
SL (Serial Number Low)
Security
IH (Read Hardware Type OID)
II (Read Identity Issuer)
IN (Read Hardware Serial Number)
UC (Load Certificates)
XC (Clear Certificates)
MicroPython
PS (MicroPython Auto Start)
PY (Execute MicroPython Command)
File system
FS (File System Commands)
API configuration
AP (API Enable)
NP (Max Packet Payload Bytes)
AT command options
CC (Command Character)
CN (Exit Command Mode)
CT (Command Mode Timeout)
GT (Guard Times)
UART interface
BD (Interface Data Rate)
FT (Flow Control Threshold)
NB (Parity)
RO (Packetization Timeout)
SB (Stop Bits)
UART pin configuration
D6 (DIO6/RTS Configuration)
D7 (DIO7/CTS Configuration)
P3 (DIO13/UART_DOUT)
P4 (DIO14/DIN Configuration)
SMT/MMT SPI interface
P5 (DIO15/SPI_MISO Configuration)
P6 (DIO16/SPI_MOSI Configuration)
P7 (DIO17/SPI_SSEL Configuration)
P8 (DIO18/SPI_CLK Configuration)
P9 (DIO19/SPI_ATTN Configuration)
I/O settings
CB (Commissioning Pushbutton)
D0 (DIO0/AD0/Commissioning Button Configuration)
D1 (DIO1/AD1/TH_SPI_ATTN Configuration)
D2 (DIO2/AD2/TH_SPI_CLK Configuration)
D3 (DIO3/AD3/TH_SPI_SSEL Configuration)
D4 (DIO4/TH_SPI_MOSI Configuration)
D5 (DIO5/Associate Configuration)
D8 (DIO8/DTR/SLP_Request Configuration)
D9 (DIO9/ON_SLEEP Configuration)
LT (Associate LED Blink Time)
M0 (PWM0 Duty Cycle)
M1 (PWM1 Duty Cycle)
P0 (DIO10/RSSI/PWM0 Configuration)
P1 (DIO11/PWM1 Configuration)
P2 (DIO12/TH_SPI_MISO Configuration)
PD (Pull Up/Down Direction)
PR (Pull-Up/Down Resistor Enable)
RP (RSSI PWM Timer)
I/O sampling
AV (Analog Voltage Reference)
IS (I/O Sample)
Location
LX (Location X - Latitude)
LY (Location Y - Longitude)
LZ (Location Z - Elevation)
Diagnostic - FW/HW Information
CK (Config CRC)
DB (Last Packet RSSI)
DD (Device Type ID)
D% (Manufacturing Date)
HV (Hardware Version)
R? (Region Code)
TP (Temperature)
VL (Version Long)
VH (Bootloader Version)
VR (Firmware Version)
%C (HW/SW Compatibility)
%P (Invoke Bootloader)
%V (Supply Voltage)
Memory access
AC (Apply Changes)
FR (Software Reset)
RE (Restore Defaults)
WR (Write)
Custom default
R1 (Restore Factory Defaults)
%F (Set Custom Default)
!C (Clear Custom Defaults)
MAC/PHY
MT (Broadcast Multi-Transmits)
PL (TX Power Level)
Version
Get started
Step 1 - Requirements
Step 2 - Register your kit
Step 3 - Set up the hardware
Step 4 - Install the software
Step 5 - Configure the Wi-SUN devices
Step 6 - Explore the Wi-SUN network in action
1. Verify Wi-SUN network communication
2. Run edge intelligence examples
3. Evaluate the Border Router’s routing capabilities
4. Experiment with network parameters
Step 7 - Connect to the cloud
Step 8 - Recap and solidify
Next steps
Reference material
API Frames
User Data Relay
User Data Relay Input - 0x2D
User Data Relay Output - 0xAD
Configuration
Local AT Command Request - 0x08
Queue Local AT Command Request - 0x09
IPv6 XBee Services Request - 0x19
Local AT Command Response - 0x88
IPv6 Remote Command - 0x1B
IPv6 Remote Command Response - 0x9B
Communication
TX Request Message - 0x1A
Socket Create - 0x40
Socket Option Request - 0x41
Socket Connect - 0x42
Socket Close - 0x43
Socket Send (Transmit) - 0x44
Socket Bind/Listen - 0x46
Socket SendTo (Transmit Explicit Data) - 0x47
Socket Create Response - 0xC0
Connection Response - 0xC1
Socket Close Response - 0xC2
Socket Close Response - 0xC3
Socket Listen Response - 0xC6
Socket New IPv6 Client - 0xCA
Socket Receive From - IPv6 - 0xCB
Socket Receive - 0xCD
Socket State - 0xCF
Status
Transmit Status - 0x89
Modem Status - 0x8A
I/O Sampling
IO Sample Indicator - 0xA7
File System
Local File System Request - 0x3B
File Open - 0x01
File Close - 0x02
File Read - 0x03
File Write - 0x04
File Hash - 0x08
Directory Create - 0x10
Directory Open - 0x11
Directory Close - 0x12
Directory Read - 0x13
Get Path ID - 0x1C
Delete - 0x2F
Volume Info - 0x40
Volume Format - 0x4F
Local File System Response - 0xBB
Remote File System IPv6 Request - 0x53
Remote File System IPv6 Response - 0xD3
AT commands
Networking
AI (Association Indication)
CE (Routing/Messaging Mode)
DO (Device Options)
IP (Transmission Protocol)
JN (Join Network)
LN (Leave Network)
NI (Node Identifier)
PB (Ping Payload Size)
PG (Ping Command)
PI (Ping Timeout)
RN (Reset Network Credential Cache)
WC (Channel Plan)
WM (PHY Mode)
WN (Network Name)
WS (Network Size)
Addressing
C0 (Source Port)
DE (Destination Port)
DL (Destination Address)
MB (IPv6 Border Router Network Address)
ML (IPv6 Link Local Network Address)
MP (IPv6 Primary Parent Network Address)
MS (IPv6 Global Secondary Parent Address)
MY (IPv6 Global Network Address)
SH (Serial Number High)
SL (Serial Number Low)
Security
IH (Read Hardware Type OID)
II (Read Identity Issuer)
IN (Read Hardware Serial Number)
UC (Load Certificates)
XC (Clear Certificates)
MicroPython
PS (MicroPython Auto Start)
PY (Execute MicroPython Command)
File system
FS (File System Commands)
API configuration
AP (API Enable)
NP (Max Packet Payload Bytes)
AT command options
CC (Command Character)
CN (Exit Command Mode)
CT (Command Mode Timeout)
GT (Guard Times)
UART interface
BD (Interface Data Rate)
FT (Flow Control Threshold)
NB (Parity)
RO (Packetization Timeout)
SB (Stop Bits)
UART pin configuration
D6 (DIO6/RTS Configuration)
D7 (DIO7/CTS Configuration)
P3 (DIO13/UART_DOUT)
P4 (DIO14/DIN Configuration)
SMT/MMT SPI interface
P5 (DIO15/SPI_MISO Configuration)
P6 (DIO16/SPI_MOSI Configuration)
P7 (DIO17/SPI_SSEL Configuration)
P8 (DIO18/SPI_CLK Configuration)
P9 (DIO19/SPI_ATTN Configuration)
I/O settings
CB (Commissioning Pushbutton)
D0 (DIO0/AD0/Commissioning Button Configuration)
D1 (DIO1/AD1/TH_SPI_ATTN Configuration)
D2 (DIO2/AD2/TH_SPI_CLK Configuration)
D3 (DIO3/AD3/TH_SPI_SSEL Configuration)
D4 (DIO4/TH_SPI_MOSI Configuration)
D5 (DIO5/Associate Configuration)
D8 (DIO8/DTR/SLP_Request Configuration)
D9 (DIO9/ON_SLEEP Configuration)
LT (Associate LED Blink Time)
M0 (PWM0 Duty Cycle)
M1 (PWM1 Duty Cycle)
P0 (DIO10/RSSI/PWM0 Configuration)
P1 (DIO11/PWM1 Configuration)
P2 (DIO12/TH_SPI_MISO Configuration)
PD (Pull Up/Down Direction)
PR (Pull-Up/Down Resistor Enable)
RP (RSSI PWM Timer)
I/O sampling
AV (Analog Voltage Reference)
IS (I/O Sample)
Location
LX (Location X - Latitude)
LY (Location Y - Longitude)
LZ (Location Z - Elevation)
Diagnostic - FW/HW Information
CK (Config CRC)
DB (Last Packet RSSI)
DD (Device Type ID)
D% (Manufacturing Date)
HV (Hardware Version)
R? (Region Code)
TP (Temperature)
VL (Version Long)
VH (Bootloader Version)
VR (Firmware Version)
%C (HW/SW Compatibility)
%P (Invoke Bootloader)
%V (Supply Voltage)
Memory access
AC (Apply Changes)
FR (Software Reset)
RE (Restore Defaults)
WR (Write)
Custom default
R1 (Restore Factory Defaults)
%F (Set Custom Default)
!C (Clear Custom Defaults)
MAC/PHY
MT (Broadcast Multi-Transmits)
PL (TX Power Level)
LN (Leave Network)
Attempt to leave a network
Parameter range
N/A
Default
N/A
LN (Leave Network)
: