Difference between revisions of "Component: Zigbee (EB051, XBEE) (XBEE) (Wireless)"
From Flowcode Help
Jump to navigationJump to searchLine 16: | Line 16: | ||
==Detailed description== | ==Detailed description== | ||
+ | |||
+ | |||
Line 26: | Line 28: | ||
==Examples== | ==Examples== | ||
+ | |||
+ | |||
Revision as of 13:32, 17 November 2021
Author | Matrix Ltd. |
Version | 1.5 |
Category | Wireless |
Contents
Zigbee (EB051, XBEE) component
Zigbee component designed to work with the XBEE range of modules from Digi. Provides a very simple interface to allow Zigbee mesh networks and communications. Also available in the form of the EB051 Zigbee E-block. Can also be used with Zigbee MIAC Addon module
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Downloadable macro reference
ReadNameFromBuffer | |
Returns a byte from the 8-Byte name | |
- BYTE | Device |
The Device name to collect. Range: 0-7 | |
- BYTE | Idx |
The index position of the name. Range: 0-7 | |
- BYTE | Return |
NodeWake | |
Wakes up the local Zigbee module from sleep mode. | |
- VOID | Return |
ReadATResponse | |
Reads a single byte from the received AT command response. | |
- BYTE | idx |
Specified the byte index in the buffer. Range 0-15 | |
- BYTE | Return |
ScanBuffer | |
Returns a binary list of matched identifier names | |
- STRING | Compare_Str |
- BYTE | Length |
- BYTE | Return |
SendChar | |
Transmits a byte value to the Zigbee module. | |
- BYTE | Byte |
Data byte to transmit. Range 0-255 | |
- VOID | Return |
InitNetwork | |
Initialises the Zigbee module and attempts to setup or join the network | |
- VOID | Return |
ConnectToCoordinator | |
Attempts to connect the data channel to the network coordinator node. | |
- BYTE | Return |
MIAC_Module_GetData | |
- BYTE | Index |
- BYTE | Return |
ConnectToName | |
Attempts to connect the data channel to a named device on the network. | |
- STRING | Name |
- BYTE | Return |
StoreParams | |
Stores the current register set into the Zigbee module's non volatile memory | |
- VOID | Return |
EnterCommandMode | |
Moves from data mode into command mode by sending the special characters | |
- VOID | Return |
RestartNetwork | |
Attempts to restart the network | |
- VOID | Return |
MIAC_Module_Message | |
- UINT | CAN_ID |
- UINT | CMD_ID |
- BYTE | Return |
ConnectToAll | |
Attempts to connect the data channel to all devices on the network. | |
- BYTE | Return |
ConnectFromLibrary | |
Attempts to connect the data channel to a known device on the network. | |
- BYTE | Mode |
- BYTE | Device |
- BYTE | Return |
ConnectToAddress | |
Attempts to connect the data channel to a specific device address on the network. | |
- STRING | Address |
- BYTE | Return |
GetSignalLevel | |
Returns the signal strength of the last signal received | |
- BYTE | Return |
ExitCommandMode | |
Returns from command mode to allow data to be sent and received | |
- VOID | Return |
MIAC_Module_PushData | |
- BYTE | Data |
- VOID | Return |
ReadAddressFromBuffer | |
Reads a byte from a 16-bit Zigbee device address | |
- BYTE | Device |
- BYTE | Idx |
- BYTE | Return |
SendATCommand | |
Transmits a string of values to the Zigbee module. | |
- STRING | Command |
Transmits a command to the Zigbee module followed by a carriage return | |
- VOID | Return |
GetATResponse | |
Waits for a response from the Zigbee module. If the Logging parameter is set then the response is stored in memory allowing the software to read the reply. | |
- BYTE | Logging |
- BYTE | Return |
ReceiveChar | |
Attempt to receive a byte from the Zigbee module. | |
- BYTE | nTimeout |
- BYTE | Return |