Digi XBee 3 ZigBee - File System

To Next Page

To Previous Page

File system

For detailed information about using MicroPython on the XBee 3 Zigbee RF Module refer to the Digi

MicroPython Programming Guide.

Overview of the file system 49

Directory structure 49

Paths 49

Limitations 49

XCTU interface 50

Digi XBee® 3 Zigbee® RF Module

Main Page

Default Chapter4
- Table of Contents4
Digi Xbee® 3 Zigbee® RF Module15
- Applicable Firmware and Hardware16
- Change the Firmware Protocol16
- Regulatory Information16
Get Started17
Configure the Xbee 3 Zigbee RF Module19
- Configure the Device Using XCTU19
- Custom Defaults19
- Custom Configuration: Create a New Factory Default19
  - Set a Custom Configuration20
  - Clear All Custom Configuration on a Device20
- Xbee Bootloader20
- Send a Firmware Image21
- Software Libraries21
- Xbee Network Assistant21
- Xbee Multi Programmer22
Update the Firmware Over-The-Air23
- Add the Device to XCTU24
- Update to the Latest Firmware24
Get Started with Micropython26
- About Micropython26
- Micropython on the Xbee 3 Zigbee RF Module26
- Use XCTU to Enter the Micropython Environment26
- Use the Micropython Terminal in XCTU27
- Micropython Examples27
- Micropython Networking and Communication Examples29
- Exit Micropython Mode37
- Other Terminal Programs37
  - Tera Term for Windows37
- Use Picocom in Linux38
- Micropython Help ()39
Secure Access42
- Secure Sessions42
- Secured Remote at Commands43
  - Secure a Node against Unauthorized Remote Configuration43
  - Remotely Configure a Node that Has Been Secured44
- Send Data to a Secured Remote Node45
- End a Session from a Server45
- Secure Session API Frames46
- Secure Transmission Failures47
  - Data Frames - 0X10 and 0X11 Frames47
  - Remote at Commands- 0X17 Frames47
File System48
- Overview of the File System49
- Directory Structure49
- Paths49
- Limitations49
- XCTU Interface50
Get Started with BLE51
- Enable BLE on the Xbee 3 Zigbee RF Module52
- Enable BLE and Configure the BLE Password52
- Get the Digi Xbee Mobile Phone Application53
- Connect with BLE and Configure Your Xbee 3 Device54
BLE Reference55
- BLE Advertising Behavior and Services56
- Device Information Service56
- Xbee API BLE Service56
- API Request Characteristic56
- API Response Characteristic57
Serial Communication59
- Serial Interface59
- UART Data Flow59
  - Serial Data59
- Serial Buffers60
  - Serial Receive Buffer60
  - Serial Transmit Buffer61
- UART Flow Control61
  - CTS Flow Control61
  - RTS Flow Control61
- Break Control61
- I2C61
SPI Operation62
- SPI Communications63
- Full Duplex Operation64
- Low Power Operation64
- Select the SPI Port65
- Force UART Operation66
Modes67
- Transparent Operating Mode68
  - Serial-To-RF Packetization68
- API Operating Mode68
- Command Mode68
- Idle Mode71
- Transmit Mode71
- Receive Mode72
- Sleep Mode72
Zigbee Networks74
- The Zigbee Specification74
- Zigbee Stack Layers74
- Zigbee Networking Concepts75
- Zigbee Application Layers: in Depth78
  - Application Support Sublayer (APS)78
  - Application Profiles78
- Zigbee Coordinator Operation80
- Router Operation85
- End Device Operation89
- Channel Scanning92
Transmission, Addressing, and Routing96
- Addressing96
  - 64-Bit Device Addresses96
  - Application Layer Addressing96
- Data Transmission96
- Binding Transmissions99
- Multicast Transmissions99
  - Address Resolution99
  - Binding Table100
- Fragmentation100
- Data Transmission Examples100
- RF Packet Routing102
- Encrypted Transmissions112
- Maximum RF Payload Size112
- Throughput114
- ZDO Transmissions114
  - Send a ZDO Command115
  - Receiving ZDO Command and Responses115
- Transmission Timeouts118
Zigbee Security123
- Security Overview123
- Network Key123
- Link Key123
- Join Window124
- Key Management125
  - Centralized Security125
  - Distributed Security125
- Device Registration125
Network Commissioning and Diagnostics132
- Place Devices132
- Device Discovery133
- Commissioning Pushbutton and Associate LED133
- Xbee 3 SMT134
- Binding137
  - End_Device_Bind_Req139
  - Example of a End_Device_Bind_Req139
- Group Table API140
Manage End Devices150
- End Device Operation150
- Parent Operation150
- Non-Parent Device Operation152
- End Device Configuration152
  - Pin Sleep153
  - Cyclic Sleep155
- Recommended Sleep Current Measurements161
- Transmit RF Data162
- Receiving RF Data162
- I/O Sampling162
- Wake End Devices with the Commissioning Pushbutton162
- Parent Verification162
- Rejoining163
- Router/Coordinator Configuration163
- Short Sleep Periods164
- Extended Sleep Periods164
- Sleep Examples165
I/O Support167
- Digital I/O Support168
- Analog I/O Support168
- Monitor I/O Lines169
- I/O Sample Data Format170
- API Frame Support171
- On-Demand Sampling171
- Periodic I/O Sampling174
  - Source174
  - Destination174
- Digital I/O Change Detection174
- I/O Behavior During Sleep175
  - Digital I/O Lines175
  - Analog and PWM I/O Lines175
AT Commands176
- Networking Commands177
- Operational Network Parameters Commands183
- Security Commands185
- Zigbee Addressing Commands189
- Zigbee Addressing Commands194
- RF Interfacing Commands196
- Serial Interfacing Commands199
- Command Mode Options205
- Micropython Commands206
  - PS (Python Startup)206
  - PY (Micropython Command)206
- File System Commands207
  - FS (File System)207
  - FK (File System Public Key)209
- BLE Commands209
- Sleep Commands211
- I/O Settings Commands214
- I/O Sampling Commands224
- Location Commands226
- Diagnostic Commands227
- Memory Access Commands230
- Custom Default Commands231
- Secure Session Commands232
API Operation234
- API Serial Exchanges235
- API Frame Format237
  - API Operation (AP Parameter = 1)237
  - API Operation with Escaped Characters (AP Parameter = 2)237
- Send ZDO Commands with the API240
  - Example242
- Send Zigbee Cluster Library (ZCL) Commands with the API243
  - Example246
- Send Public Profile Commands with the API248
  - Frame Specific Data248
  - Example251
Framedescriptions255
- AT Command Frame - 0X08255
- AT Command - Queue Parameter Value Frame - 0X09257
- Transmit Request Frame - 0X10259
- Explicit Addressing Command Frame - 0X11262
- Remote at Command Request Frame - 0X17265
- Create Source Route - 0X21268
- Register Joining Device - 0X24270
- BLE Unlock API Frame - 0X2C274
  - Example Sequence to Perform at Command Xbee API Frames over BLE276
- User Data Relay Frame - 0X2D277
  - Example Use Cases278
  - Example278
- Secure Session Control Frame - 0X2E279
- AT Command Response Frame - 0X88283
- Modem Status Frame - 0X8A285
- Transmit Status Frame - 0X8B287
- TX Status Frame - 0X89288
- Receive Packet Frame - 0X90290
- Explicit Rx Indicator Frame - 0X91292
- I/O Data Sample Rx Indicator Frame - 0X92295
- Node Identification Indicator Frame - 0X95298
- Remote Command Response Frame - 0X97301
- Extended Modem Status Frame - 0X98303
  - Verbose Join Status Code Descriptions306
- Route Record Indicator - 0Xa1312
- Register Device Status - 0Xa4313
- Many-To-One Route Request Indicator - 0Xa3315
- BLE Unlock Response Frame - 0Xac316
- User Data Relay Output - 0Xad316
  - Example317
- Secure Session Response Frame - 0Xae317
Over-The-Air Firmware/File System Upgrade Process for Zigbee 3.0320
- FOTA Upgrade Image File Formats320
- Storage321
- ZCL OTA Messaging321
- Image Notify322
- Create the Image Notify Request322
- Query Next Image Request324
- Query Next Image Response326
- Image Block Request328
- Image Block Response330
- Upgrade End Request333
- Upgrade End Response334
- ZCL OTA Cluster Status Codes337
OTA File System Upgrades339
- OTA File System Update Process340
- OTA File System Updates Using XCTU340
- OTA File System Updates: OEM344

Digi XBee 3 ZigBee - File System

Table of Contents

Related product manuals