Skip to content

Wi-SUN support #100

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ devices:
* Digi XBee 3 Global LTE Cat 1 (firmware 41519 and later)
* Digi XBee 3 North America LTE Cat 1 (firmware 11519 and later)
* Digi XBee BLU (firmware 4000 and later)
* Digi XBee Wi-SUN (firmware version B000 and later)


Organization
Expand Down Expand Up @@ -91,7 +92,7 @@ document.
License
-------

This software is open-source software. Copyright Digi International, 2018-2024.
This software is open-source software. Copyright Digi International, 2018-2025.

Samples within `samples/` folder, stub files in `typehints/` folder and most of
the source code in the `lib/` directory is covered by the
Expand Down
1 change: 1 addition & 0 deletions lib/sensor/ds1621/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,4 @@ Supported platforms
* Digi XBee 3 Global LTE-M/NB-IoT - minimum firmware version: x18
* Digi XBee 3 Global LTE Cat 1 - minimum firmware version: 11519
* Digi XBee 3 North America LTE Cat 1 - minimum firmware version: 41519
* Digi XBee Wi-SUN - minimum firmware version: B000
1 change: 1 addition & 0 deletions lib/sensor/hdc1080/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,4 @@ Supported platforms
* Digi XBee 3 Global LTE-M/NB-IoT - minimum firmware version: x18
* Digi XBee 3 Global LTE Cat 1 - minimum firmware version: 11519
* Digi XBee 3 North America LTE Cat 1 - minimum firmware version: 41519
* Digi XBee Wi-SUN - minimum firmware version: B000
8 changes: 8 additions & 0 deletions platforms/platforms.xml
Original file line number Diff line number Diff line change
Expand Up @@ -82,4 +82,12 @@
<drm_type>XBee BLU</drm_type>
</drm_types>
</platform>
<platform id="Digi XBee Wi-SUN">
<icon>xbee_wisun.png</icon>
<category_id>xbee</category_id>
<drm_types>
<drm_type>XBee Wi-SUN TH</drm_type>
<drm_type>XBee Wi-SUN</drm_type>
</drm_types>
</platform>
</platforms>
Binary file added platforms/xbee_wisun.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 2 additions & 1 deletion samples/adc_polling/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,11 +103,12 @@ Supported platforms
* Digi XBee 3 Global LTE Cat 1 - minimum firmware version: 11519
* Digi XBee 3 North America LTE Cat 1 - minimum firmware version: 41519
* Digi XBee BLU - minimum firmware version: 4000
* Digi XBee Wi-SUN - minimum firmware version: B000

License
-------

Copyright (c) 2019-2024, Digi International, Inc.
Copyright (c) 2019-2025, Digi International, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
3 changes: 2 additions & 1 deletion samples/filesystem/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,11 +59,12 @@ Supported platforms
* Digi XBee 3 Global LTE Cat 1 - minimum firmware version: 11519
* Digi XBee 3 North America LTE Cat 1 - minimum firmware version: 41519
* Digi XBee BLU - minimum firmware version: 4000
* Digi XBee Wi-SUN - minimum firmware version: B000

License
-------

Copyright (c) 2019-2024, Digi International, Inc.
Copyright (c) 2019-2025, Digi International, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
3 changes: 2 additions & 1 deletion samples/gpio/blinking_led/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,11 +51,12 @@ Supported platforms
* Digi XBee 3 Global LTE Cat 1 - minimum firmware version: 11519
* Digi XBee 3 North America LTE Cat 1 - minimum firmware version: 41519
* Digi XBee BLU - minimum firmware version: 4000
* Digi XBee Wi-SUN - minimum firmware version: B000

License
-------

Copyright (c) 2019-2024, Digi International, Inc.
Copyright (c) 2019-2025, Digi International, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
3 changes: 2 additions & 1 deletion samples/gpio/digital_input/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,11 +54,12 @@ Supported platforms
* Digi XBee 3 Global LTE Cat 1 - minimum firmware version: 11519
* Digi XBee 3 North America LTE Cat 1 - minimum firmware version: 41519
* Digi XBee BLU - minimum firmware version: 4000
* Digi XBee Wi-SUN - minimum firmware version: B000

License
-------

Copyright (c) 2019-2024, Digi International, Inc.
Copyright (c) 2019-2025, Digi International, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
3 changes: 2 additions & 1 deletion samples/i2c/i2c_ds1621_library/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,11 +82,12 @@ Supported platforms
* Digi XBee 3 Global LTE-M/NB-IoT - minimum firmware version: x18
* Digi XBee 3 Global LTE Cat 1 - minimum firmware version: 11519
* Digi XBee 3 North America LTE Cat 1 - minimum firmware version: 41519
* Digi XBee Wi-SUN - minimum firmware version: B000

License
-------

Copyright (c) 2019, Digi International, Inc.
Copyright (c) 2019-2025, Digi International, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
3 changes: 2 additions & 1 deletion samples/i2c/i2c_eeprom/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,11 +108,12 @@ Supported platforms
* Digi XBee 3 Global LTE-M/NB-IoT - minimum firmware version: x18
* Digi XBee 3 Global LTE Cat 1 - minimum firmware version: 11519
* Digi XBee 3 North America LTE Cat 1 - minimum firmware version: 41519
* Digi XBee Wi-SUN - minimum firmware version: B000

License
-------

Copyright (c) 2019, Digi International, Inc.
Copyright (c) 2019-2025, Digi International, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
3 changes: 2 additions & 1 deletion samples/i2c/i2c_hdc1080/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,11 +77,12 @@ Supported platforms
* Digi XBee 3 Global LTE-M/NB-IoT - minimum firmware version: x18
* Digi XBee 3 Global LTE Cat 1 - minimum firmware version: 11519
* Digi XBee 3 North America LTE Cat 1 - minimum firmware version: 41519
* Digi XBee Wi-SUN - minimum firmware version: B000

License
-------

Copyright (c) 2019, Digi International, Inc.
Copyright (c) 2019-2025, Digi International, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
3 changes: 2 additions & 1 deletion samples/i2c/i2c_hdc1080_library/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,11 +86,12 @@ Supported platforms
* Digi XBee 3 Global LTE-M/NB-IoT - minimum firmware version: x18
* Digi XBee 3 Global LTE Cat 1 - minimum firmware version: 11519
* Digi XBee 3 North America LTE Cat 1 - minimum firmware version: 41519
* Digi XBee Wi-SUN - minimum firmware version: B000

License
-------

Copyright (c) 2019, Digi International, Inc.
Copyright (c) 2019-2025, Digi International, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
3 changes: 2 additions & 1 deletion samples/i2c/i2c_scanner/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,11 +78,12 @@ Supported platforms
* Digi XBee 3 Global LTE-M/NB-IoT - minimum firmware version: x18
* Digi XBee 3 Global LTE Cat 1 - minimum firmware version: 11519
* Digi XBee 3 North America LTE Cat 1 - minimum firmware version: 41519
* Digi XBee Wi-SUN - minimum firmware version: B000

License
-------

Copyright (c) 2019, Digi International, Inc.
Copyright (c) 2019-2025, Digi International, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
3 changes: 2 additions & 1 deletion samples/pwm_duty/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,11 +71,12 @@ Supported platforms
* Digi XBee 3 Global LTE-M/NB-IoT - minimum firmware version: x18
* Digi XBee 3 Global LTE Cat 1 - minimum firmware version: 11519
* Digi XBee 3 North America LTE Cat 1 - minimum firmware version: 41519
* Digi XBee Wi-SUN - minimum firmware version: B000

License
-------

Copyright (c) 2019, Digi International, Inc.
Copyright (c) 2019-2025, Digi International, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
3 changes: 2 additions & 1 deletion samples/watchdog/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,12 @@ Supported platforms
* Digi XBee3 802.15.4 - minimum firmware version: 200A
* Digi XBee3 DigiMesh 2.4 - minimum firmware version: 300A
* Digi XBee BLU - minimum firmware version: 4000
* Digi XBee Wi-SUN - minimum firmware version: B000

License
-------

Copyright (c) 2020-2024, Digi International, Inc.
Copyright (c) 2019-2025, Digi International, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
3 changes: 2 additions & 1 deletion samples/xbee/at_commands/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,11 +51,12 @@ Supported platforms
* Digi XBee 3 Global LTE Cat 1 - minimum firmware version: 11519
* Digi XBee 3 North America LTE Cat 1 - minimum firmware version: 41519
* Digi XBee BLU - minimum firmware version: 4000
* Digi XBee Wi-SUN - minimum firmware version: B000

License
-------

Copyright (c) 2019-2024, Digi International, Inc.
Copyright (c) 2019-2025, Digi International, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
98 changes: 98 additions & 0 deletions samples/xbee/communication/receive_data_ipv6/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
Receive Data IPv6 Sample Application
====================================

This example demonstrates the usage of the socket IPv6 API by giving an example
of how to receive data from other XBee device in the same Wi-SUN network.

Requirements
------------

To run this example you need:

* Two XBee Wi-SUN modules.
* Two carrier boards for the radio modules (XBIB-U-DEV or XBIB-C board).
* One Wi-SUN border router.
* Digi XBee Studio v1.2.0 or higher (available at www.digi.com/xbee-studio).

Setup
-----

The XBee module that runs this sample will act as receiver, while the other
one will act as sender.

Make sure the hardware is set up correctly:

1. Plug the XBee radio modules into the XBee adapters and connect them to your
computer's USB ports.
2. Ensure that the sender module is in API mode and both modules are on the
same Wi-SUN network.

Run
---

The example is already configured, so all you need to do is to compile and
launch the application.

Then, you need to send a data frame to the receiver module from the sender one.
Follow these steps to do so:

1. Open XBee Studio and wait until the sender XBee module is discovered.
2. In the left menu, go to the **XBee Console** page and open the connection.
3. Create and add an API frame to the **Send data** list with the following
parameters:

- Frame type: 0x40 - Socket Create
- Frame ID: 01
- Protocol: UDP [00]

4. Send this packet by selecting it and clicking the **Send selected packet**
button. Click the received *Socket Create Response* packet and look for the
assigned *Socket ID*.
5. Create another API frame with the following parameters:

- Frame type: 0x47 - Socket SendTo
- Frame ID: 02
- Socket ID: Use the ID received in the previous packet
- Dest. address: Use the IPv6 address printed in the REPL console
- Dest. port: 12 34
- Transmit options: 00
- Payload: Hello, Wi-SUN module!

6. Send this packet by selecting it and clicking the **Send selected packet**
button.

When the data frame is sent, verify that a line with the sender address and the
data included in the **Payload** field is printed out in the REPL console:

Data received from XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX >> Hello, Wi-SUN module!

Where *XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX* is the IPv6 address of the
sender module.

Supported platforms
-------------------

* Digi XBee Wi-SUN - minimum firmware version: B000

License
-------

Copyright (c) 2025, Digi International, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
55 changes: 55 additions & 0 deletions samples/xbee/communication/receive_data_ipv6/main.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Copyright (c) 2025, Digi International, Inc.
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.

import socket
import time
import xbee


PORT = 0x1234


print(" +-------------------------------------------+")
print(" | XBee MicroPython Receive Data IPv6 Sample |")
print(" +-------------------------------------------+\n")

print("Waiting for the module to be connected to the network...")

ai = xbee.atcmd("AI")
while ai != 0:
time.sleep(1)
ai = xbee.atcmd("AI")

local_addr = xbee.atcmd("MY")
print("Receiver IPv6 address: %s" % local_addr)

# Create the socket.
s = socket.socket(socket.AF_INET6, socket.SOCK_DGRAM)
s.bind((local_addr, PORT))

print("Waiting for data...\n")

try:
while True:
# Receive messages.
data, address = s.recvfrom(1024)
print("Data received from %s >> %s" % (address, data.decode()))
finally:
s.close()
3 changes: 2 additions & 1 deletion samples/xbee/communication/relay_frames/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,11 +75,12 @@ Supported platforms
* Digi XBee 3 Global LTE Cat 1 - minimum firmware version: 11519
* Digi XBee 3 North America LTE Cat 1 - minimum firmware version: 41519
* Digi XBee BLU - minimum firmware version: 4000
* Digi XBee Wi-SUN - minimum firmware version: B000

License
-------

Copyright (c) 2019-2024, Digi International, Inc.
Copyright (c) 2019-2025, Digi International, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
3 changes: 2 additions & 1 deletion samples/xbee/communication/relay_frames_button/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,11 +64,12 @@ Supported platforms
* Digi XBee 3 Global LTE Cat 1 - minimum firmware version: 11519
* Digi XBee 3 North America LTE Cat 1 - minimum firmware version: 41519
* Digi XBee BLU - minimum firmware version: 4000
* Digi XBee Wi-SUN - minimum firmware version: B000

License
-------

Copyright (c) 2019-2024, Digi International, Inc.
Copyright (c) 2019-2025, Digi International, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
Loading