Difference between revisions of "Component: Zigbee (EB051, XBEE) (Wireless)"
(XML import) |
(XML import) |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| + | |||
| + | |||
{| width="50%" | {| width="50%" | ||
|- | |- | ||
| Line 5: | Line 7: | ||
|- | |- | ||
| width="20%" style="color: gray;" | Version | | width="20%" style="color: gray;" | Version | ||
| − | | 1. | + | | 1.5 (Release) |
|- | |- | ||
| width="20%" style="color: gray;" | Category | | width="20%" style="color: gray;" | Category | ||
| Line 16: | Line 18: | ||
Zigbee component designed to work with the XBEE range of modules from Digi. | 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. | Provides a very simple interface to allow Zigbee mesh networks and communications. | ||
| − | Also available in the form of the EB051 Zigbee E-block. | + | Also available in the form of the EB051 Zigbee E-block. Can also be used with Zigbee MIAC Addon module |
==Examples== | ==Examples== | ||
| − | + | ===Communications Demo=== | |
| + | |||
| + | Here is an example file for a Zigbee Coordinator to set up a Zigbee network. | ||
| + | {{Fcfile|Zigbee_Test.fcfx|Zigbee Coordinator}} | ||
| + | Here is an example file for a Zigbee router / end device to connect to the Zigbee network and transfer data. | ||
| + | {{Fcfile|Zigbee_Test_Slave.fcfx|Zigbee Router / End device}} | ||
| + | The coordinator example sets up the network and periodically sends out an incrementing byte value. The router / end device example receives the byte sent from the coordinator and outputs this to the PORTB pins before replying back to the coordinator with the incoming value plus 128. | ||
| + | |||
| + | |||
| + | ===Read & Display ADC=== | ||
| + | Here is an example file for a Zigbee Coordinator to set up a Zigbee network, request sensor readings and display them on a graphical LCD. | ||
| + | {{Fcfile|Node 1.fcfx|Zigbee Coordinator}} | ||
| + | Here is an example file for a Zigbee router / end device to connect to the Zigbee network, wait for commands from the coordinator and then sample the ADC and transmit the value. | ||
| + | {{Fcfile|Node 2.fcfx|Zigbee Router / End device}} | ||
| + | The coordinator example sets up the network and periodically sends out a byte to inform node 2 to take an ADC sample. The router / end device example receives the byte sent from the coordinator and collects the reading from the ADC before transmitting the value back to the coordinator. | ||
==Downloadable macro reference== | ==Downloadable macro reference== | ||
===<span style="font-weight: normal;"><u><tt>NodeConfigureSleep</tt></u></span>=== | ===<span style="font-weight: normal;"><u><tt>NodeConfigureSleep</tt></u></span>=== | ||
| − | Sets the Zigbee device sleep mode (only applicable for end node type devices) | + | Sets the Zigbee device sleep mode (only applicable for end node type devices) , |
'''Parameters''' | '''Parameters''' | ||
:[[Variable Types|BYTE]] ''Mode'' | :[[Variable Types|BYTE]] ''Mode'' | ||
| + | ::1=Hibernate, 2=Doze, 4=Cyclic Sleep, 5=Cyclic Doze | ||
:[[Variable Types|UINT]] ''Timeout'' | :[[Variable Types|UINT]] ''Timeout'' | ||
| + | ::Time to sleep in milli seconds (ms) | ||
| Line 45: | Line 63: | ||
:[[Variable Types|BYTE]] ''Device'' | :[[Variable Types|BYTE]] ''Device'' | ||
| + | ::The Device name to collect. Range: 0-7 | ||
:[[Variable Types|BYTE]] ''Idx'' | :[[Variable Types|BYTE]] ''Idx'' | ||
| + | ::The index position of the name. Range: 0-7 | ||
| Line 64: | Line 84: | ||
'''Return value''' | '''Return value''' | ||
| − | : | + | :''This call does not return a value'' |
| Line 73: | Line 93: | ||
:[[Variable Types|BYTE]] ''idx'' | :[[Variable Types|BYTE]] ''idx'' | ||
| + | ::Specified the byte index in the buffer. Range 0-15 | ||
| Line 96: | Line 117: | ||
===<span style="font-weight: normal;"><u><tt>SendChar</tt></u></span>=== | ===<span style="font-weight: normal;"><u><tt>SendChar</tt></u></span>=== | ||
| − | + | Transmits a byte value to the Zigbee module. | |
| − | |||
| − | |||
'''Parameters''' | '''Parameters''' | ||
:[[Variable Types|BYTE]] ''Byte'' | :[[Variable Types|BYTE]] ''Byte'' | ||
| + | ::Data byte to transmit. Range 0-255 | ||
| Line 141: | Line 161: | ||
'''Parameters''' | '''Parameters''' | ||
| − | :[[Variable Types|STRING]] ''Name'' | + | :[[Variable Types|<- STRING]] ''Name'' |
| + | ::''This parameter may be returned back to the caller'' | ||
| Line 221: | Line 242: | ||
'''Parameters''' | '''Parameters''' | ||
| − | :[[Variable Types|STRING]] ''Address'' | + | :[[Variable Types|<- STRING]] ''Address'' |
| + | ::''This parameter may be returned back to the caller'' | ||
| Line 271: | Line 293: | ||
===<span style="font-weight: normal;"><u><tt>SendATCommand</tt></u></span>=== | ===<span style="font-weight: normal;"><u><tt>SendATCommand</tt></u></span>=== | ||
| − | + | Transmits a string of values to the Zigbee module. | |
| − | |||
| − | |||
'''Parameters''' | '''Parameters''' | ||
| − | :[[Variable Types|STRING]] ''Command'' | + | :[[Variable Types|<- STRING]] ''Command'' |
::Transmits a command to the Zigbee module followed by a carriage return | ::Transmits a command to the Zigbee module followed by a carriage return | ||
| + | ::''This parameter may be returned back to the caller'' | ||
| Line 313: | Line 334: | ||
===<span style="font-weight: normal;"><u><tt>ReceiveChar</tt></u></span>=== | ===<span style="font-weight: normal;"><u><tt>ReceiveChar</tt></u></span>=== | ||
| − | + | Attempt to receive a byte from the Zigbee module. | |
| − | |||
| − | |||
'''Parameters''' | '''Parameters''' | ||
| Line 338: | Line 357: | ||
This property is of type ''Line of text'' and can be referenced with the variable name ''dev_name''. | This property is of type ''Line of text'' and can be referenced with the variable name ''dev_name''. | ||
| − | + | String of characters used to allow the Zigbee node to use the name addressing mode of operation. | |
| − | |||
| + | Can be left blank if name addressing is not being used. | ||
<span style="font-weight: normal;"><u>Zigbee Mode</u></span> | <span style="font-weight: normal;"><u>Zigbee Mode</u></span> | ||
| Line 346: | Line 365: | ||
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''zig_mode''. | This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''zig_mode''. | ||
| − | + | Specifies the functionality of the Zigbee node. | |
| + | Coordinator - Must be used with a Coordinator Zigbee E-Block EB051C, Responsible for starting the network and assigning addresses. | ||
| + | Router - Must be used with a Router / End Node E-Block EB051R, Responsible for forwarding / repeating packets on the network. | ||
| + | |||
| + | End Device - Must be used with a Router / End Node E-Block EB051R, Capable of low power operation. | ||
<span style="font-weight: normal;"><u>Auto ID</u></span> | <span style="font-weight: normal;"><u>Auto ID</u></span> | ||
| Line 354: | Line 377: | ||
This property is of type ''True or false'' and can be referenced with the variable name ''auto_id''. | This property is of type ''True or false'' and can be referenced with the variable name ''auto_id''. | ||
| − | + | Automatically generate a PAN ID | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>PAN ID</u></span> | <span style="font-weight: normal;"><u>PAN ID</u></span> | ||
| Line 362: | Line 383: | ||
This property is of type ''Line of text'' and can be referenced with the variable name ''pan_id''. | This property is of type ''Line of text'' and can be referenced with the variable name ''pan_id''. | ||
| − | + | Assigns a Personal Area Network Identifier code to the Zigbee node. | |
| + | Random / Search - Scans the local area for Zigbee PAN networks and joins the existing network, otherwise a random value is chosen. | ||
| + | Preset - Assigns a preset PAN ID to the Zigbee node, Must be between 0x0 and 0x3FFF. | ||
<span style="font-weight: normal;"><u>Node Join Time</u></span> | <span style="font-weight: normal;"><u>Node Join Time</u></span> | ||
| Line 370: | Line 393: | ||
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''join_time''. | This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''join_time''. | ||
| − | + | Length of time in seconds where nodes are allowed to join the network. | |
| − | |||
| + | Infinte - Nodes are always allowed to join the network. | ||
| − | + | Preset - Nodes are only allowed to join the network for a specific amount of time. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| + | Note: Join time not available for End Device nodes. | ||
<span style="font-weight: normal;"><u>Max Hops</u></span> | <span style="font-weight: normal;"><u>Max Hops</u></span> | ||
| Line 386: | Line 405: | ||
This property is of type ''Signed integer'' and can be referenced with the variable name ''max_hops''. | This property is of type ''Signed integer'' and can be referenced with the variable name ''max_hops''. | ||
| − | + | Specifies the maximum number of retransmits for a Broadcast transmission. | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Sleep Buffer Time</u></span> | <span style="font-weight: normal;"><u>Sleep Buffer Time</u></span> | ||
| Line 394: | Line 411: | ||
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''sleep_buffer''. | This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''sleep_buffer''. | ||
| − | + | Length of time to buffer packets for sleeping or powered down nodes. This value must be consistent throughout the Zigbee network. | |
| + | Default - Assigns the maximum buffer time of 28 seconds. | ||
| + | Preset - Allows for a custom sleep time of 0.32 - 28 seconds. | ||
<span style="font-weight: normal;"><u>UART Channel</u></span> | <span style="font-weight: normal;"><u>UART Channel</u></span> | ||
| Line 402: | Line 421: | ||
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Channel''. | This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Channel''. | ||
| − | + | UART peripheral used to communicate with the Zigbee module | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>RX Pin</u></span> | <span style="font-weight: normal;"><u>RX Pin</u></span> | ||
| Line 410: | Line 427: | ||
This property is of type ''Single digital pin'' and can be referenced with the variable name ''rx_pin''. | This property is of type ''Single digital pin'' and can be referenced with the variable name ''rx_pin''. | ||
| − | + | UART Receive Pin | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>TX Pin</u></span> | <span style="font-weight: normal;"><u>TX Pin</u></span> | ||
| Line 418: | Line 433: | ||
This property is of type ''Single digital pin'' and can be referenced with the variable name ''tx_pin''. | This property is of type ''Single digital pin'' and can be referenced with the variable name ''tx_pin''. | ||
| − | + | UART Transmit Pin | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Sleep Pin</u></span> | <span style="font-weight: normal;"><u>Sleep Pin</u></span> | ||
| Line 426: | Line 439: | ||
This property is of type ''Single digital pin'' and can be referenced with the variable name ''pin_sleep''. | This property is of type ''Single digital pin'' and can be referenced with the variable name ''pin_sleep''. | ||
| − | + | Zigbee Sleep Control Pin | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Flow Control</u></span> | <span style="font-weight: normal;"><u>Flow Control</u></span> | ||
| Line 434: | Line 445: | ||
This property is of type ''True or false'' and can be referenced with the variable name ''flow_control''. | This property is of type ''True or false'' and can be referenced with the variable name ''flow_control''. | ||
| − | + | Determines if the UART communications has additional flow control enabled. | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>RTS Pin</u></span> | <span style="font-weight: normal;"><u>RTS Pin</u></span> | ||
| Line 442: | Line 451: | ||
This property is of type ''Single digital pin'' and can be referenced with the variable name ''pin_rts''. | This property is of type ''Single digital pin'' and can be referenced with the variable name ''pin_rts''. | ||
| − | + | Request to send flow control pin | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>CTS Pin</u></span> | <span style="font-weight: normal;"><u>CTS Pin</u></span> | ||
| Line 450: | Line 457: | ||
This property is of type ''Single digital pin'' and can be referenced with the variable name ''pin_cts''. | This property is of type ''Single digital pin'' and can be referenced with the variable name ''pin_cts''. | ||
| − | + | Clear to send flow control pin | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>0x0B</u></span> | <span style="font-weight: normal;"><u>0x0B</u></span> | ||
| Line 458: | Line 463: | ||
This property is of type ''True or false'' and can be referenced with the variable name ''chan_0''. | This property is of type ''True or false'' and can be referenced with the variable name ''chan_0''. | ||
| − | + | Determines if channel will be scanned | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>0x0C</u></span> | <span style="font-weight: normal;"><u>0x0C</u></span> | ||
| Line 466: | Line 469: | ||
This property is of type ''True or false'' and can be referenced with the variable name ''chan_1''. | This property is of type ''True or false'' and can be referenced with the variable name ''chan_1''. | ||
| − | + | Determines if channel will be scanned | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>0x0D</u></span> | <span style="font-weight: normal;"><u>0x0D</u></span> | ||
| Line 474: | Line 475: | ||
This property is of type ''True or false'' and can be referenced with the variable name ''chan_2''. | This property is of type ''True or false'' and can be referenced with the variable name ''chan_2''. | ||
| − | + | Determines if channel will be scanned | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>0x0E</u></span> | <span style="font-weight: normal;"><u>0x0E</u></span> | ||
| Line 482: | Line 481: | ||
This property is of type ''True or false'' and can be referenced with the variable name ''chan_3''. | This property is of type ''True or false'' and can be referenced with the variable name ''chan_3''. | ||
| − | + | Determines if channel will be scanned | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>0x0F</u></span> | <span style="font-weight: normal;"><u>0x0F</u></span> | ||
| Line 490: | Line 487: | ||
This property is of type ''True or false'' and can be referenced with the variable name ''chan_4''. | This property is of type ''True or false'' and can be referenced with the variable name ''chan_4''. | ||
| − | + | Determines if channel will be scanned | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>0x10</u></span> | <span style="font-weight: normal;"><u>0x10</u></span> | ||
| Line 498: | Line 493: | ||
This property is of type ''True or false'' and can be referenced with the variable name ''chan_5''. | This property is of type ''True or false'' and can be referenced with the variable name ''chan_5''. | ||
| − | + | Determines if channel will be scanned | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>0x11</u></span> | <span style="font-weight: normal;"><u>0x11</u></span> | ||
| Line 506: | Line 499: | ||
This property is of type ''True or false'' and can be referenced with the variable name ''chan_6''. | This property is of type ''True or false'' and can be referenced with the variable name ''chan_6''. | ||
| − | + | Determines if channel will be scanned | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>0x12</u></span> | <span style="font-weight: normal;"><u>0x12</u></span> | ||
| Line 514: | Line 505: | ||
This property is of type ''True or false'' and can be referenced with the variable name ''chan_7''. | This property is of type ''True or false'' and can be referenced with the variable name ''chan_7''. | ||
| − | + | Determines if channel will be scanned | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>0x13</u></span> | <span style="font-weight: normal;"><u>0x13</u></span> | ||
| Line 522: | Line 511: | ||
This property is of type ''True or false'' and can be referenced with the variable name ''chan_8''. | This property is of type ''True or false'' and can be referenced with the variable name ''chan_8''. | ||
| − | + | Determines if channel will be scanned | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>0x14</u></span> | <span style="font-weight: normal;"><u>0x14</u></span> | ||
| Line 530: | Line 517: | ||
This property is of type ''True or false'' and can be referenced with the variable name ''chan_9''. | This property is of type ''True or false'' and can be referenced with the variable name ''chan_9''. | ||
| − | + | Determines if channel will be scanned | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>0x15</u></span> | <span style="font-weight: normal;"><u>0x15</u></span> | ||
| Line 538: | Line 523: | ||
This property is of type ''True or false'' and can be referenced with the variable name ''chan_10''. | This property is of type ''True or false'' and can be referenced with the variable name ''chan_10''. | ||
| − | + | Determines if channel will be scanned | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>0x16</u></span> | <span style="font-weight: normal;"><u>0x16</u></span> | ||
| Line 546: | Line 529: | ||
This property is of type ''True or false'' and can be referenced with the variable name ''chan_11''. | This property is of type ''True or false'' and can be referenced with the variable name ''chan_11''. | ||
| − | + | Determines if channel will be scanned | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>0x17</u></span> | <span style="font-weight: normal;"><u>0x17</u></span> | ||
| Line 554: | Line 535: | ||
This property is of type ''True or false'' and can be referenced with the variable name ''chan_12''. | This property is of type ''True or false'' and can be referenced with the variable name ''chan_12''. | ||
| − | + | Determines if channel will be scanned | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>0x18</u></span> | <span style="font-weight: normal;"><u>0x18</u></span> | ||
| Line 562: | Line 541: | ||
This property is of type ''True or false'' and can be referenced with the variable name ''chan_13''. | This property is of type ''True or false'' and can be referenced with the variable name ''chan_13''. | ||
| − | + | Determines if channel will be scanned | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>0x19</u></span> | <span style="font-weight: normal;"><u>0x19</u></span> | ||
| Line 570: | Line 547: | ||
This property is of type ''True or false'' and can be referenced with the variable name ''chan_14''. | This property is of type ''True or false'' and can be referenced with the variable name ''chan_14''. | ||
| − | + | Determines if channel will be scanned | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>0x1A</u></span> | <span style="font-weight: normal;"><u>0x1A</u></span> | ||
| Line 578: | Line 553: | ||
This property is of type ''True or false'' and can be referenced with the variable name ''chan_15''. | This property is of type ''True or false'' and can be referenced with the variable name ''chan_15''. | ||
| − | + | Determines if channel will be scanned | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Scan Duration</u></span> | <span style="font-weight: normal;"><u>Scan Duration</u></span> | ||
| Line 586: | Line 559: | ||
This property is of type ''Signed integer'' and can be referenced with the variable name ''scan_duration''. | This property is of type ''Signed integer'' and can be referenced with the variable name ''scan_duration''. | ||
| − | + | Configures the length of time to scan each channel for network activity. The overall time for the entire channel scan is shown as channel scan time. | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Total Scan Time (ms)</u></span> | <span style="font-weight: normal;"><u>Total Scan Time (ms)</u></span> | ||
| Line 594: | Line 565: | ||
This property is of type ''Signed integer'' and can be referenced with the variable name ''scan_total''. | This property is of type ''Signed integer'' and can be referenced with the variable name ''scan_total''. | ||
| − | + | The total amount of time that it will take to perform a complete RF channel scan based on the selected scan channels and duration. | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Label</u></span> | <span style="font-weight: normal;"><u>Label</u></span> | ||
Latest revision as of 17:59, 18 March 2016
| Author | Matrix Ltd. |
| Version | 1.5 (Release) |
| Category | Wireless |
Contents
- 1 Zigbee (EB051, XBEE) component
- 2 Examples
- 3 Downloadable macro reference
- 3.1 NodeConfigureSleep
- 3.2 ReadNameFromBuffer
- 3.3 NodeWake
- 3.4 ReadATResponse
- 3.5 ScanBuffer
- 3.6 SendChar
- 3.7 InitNetwork
- 3.8 ConnectToCoordinator
- 3.9 ConnectToName
- 3.10 StoreParams
- 3.11 EnterCommandMode
- 3.12 RestartNetwork
- 3.13 ConnectToAll
- 3.14 ConnectFromLibrary
- 3.15 ConnectToAddress
- 3.16 GetSignalLevel
- 3.17 ExitCommandMode
- 3.18 ReadAddressFromBuffer
- 3.19 SendATCommand
- 3.20 ScanNetwork
- 3.21 GetATResponse
- 3.22 ReceiveChar
- 4 Simulation macro reference
- 5 Property reference
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
Examples
Communications Demo
Here is an example file for a Zigbee Coordinator to set up a Zigbee network.
Zigbee Coordinator
Here is an example file for a Zigbee router / end device to connect to the Zigbee network and transfer data.
Zigbee Router / End device
The coordinator example sets up the network and periodically sends out an incrementing byte value. The router / end device example receives the byte sent from the coordinator and outputs this to the PORTB pins before replying back to the coordinator with the incoming value plus 128.
Read & Display ADC
Here is an example file for a Zigbee Coordinator to set up a Zigbee network, request sensor readings and display them on a graphical LCD.
Zigbee Coordinator
Here is an example file for a Zigbee router / end device to connect to the Zigbee network, wait for commands from the coordinator and then sample the ADC and transmit the value.
Zigbee Router / End device
The coordinator example sets up the network and periodically sends out a byte to inform node 2 to take an ADC sample. The router / end device example receives the byte sent from the coordinator and collects the reading from the ADC before transmitting the value back to the coordinator.
Downloadable macro reference
NodeConfigureSleep
Sets the Zigbee device sleep mode (only applicable for end node type devices) ,
Parameters
- BYTE Mode
- 1=Hibernate, 2=Doze, 4=Cyclic Sleep, 5=Cyclic Doze
- UINT Timeout
- Time to sleep in milli seconds (ms)
Return value
- This call does not return a value
ReadNameFromBuffer
Returns a byte from the 8-Byte name
Parameters
- BYTE Device
- The Device name to collect. Range: 0-7
- BYTE Idx
- The index position of the name. Range: 0-7
Return value
NodeWake
Wakes up the local Zigbee module from sleep mode.
Parameters
- This macro has no parameters
Return value
- This call does not return a value
ReadATResponse
Reads a single byte from the received AT command response.
Parameters
- BYTE idx
- Specified the byte index in the buffer. Range 0-15
Return value
ScanBuffer
Returns a binary list of matched identifier names
Parameters
- STRING Compare_Str
- BYTE Length
Return value
SendChar
Transmits a byte value to the Zigbee module.
Parameters
- BYTE Byte
- Data byte to transmit. Range 0-255
Return value
- This call does not return a value
InitNetwork
Initialises the Zigbee module and attempts to setup or join the network
Parameters
- This macro has no parameters
Return value
- This call does not return a value
ConnectToCoordinator
Attempts to connect the data channel to the network coordinator node.
Parameters
- This macro has no parameters
Return value
ConnectToName
Attempts to connect the data channel to a named device on the network.
Parameters
- <- STRING Name
- This parameter may be returned back to the caller
Return value
StoreParams
Stores the current register set into the Zigbee module's non volatile memory
Parameters
- This macro has no parameters
Return value
- This call does not return a value
EnterCommandMode
Moves from data mode into command mode by sending the special characters
Parameters
- This macro has no parameters
Return value
- This call does not return a value
RestartNetwork
Attempts to restart the network
Parameters
- This macro has no parameters
Return value
- This call does not return a value
ConnectToAll
Attempts to connect the data channel to all devices on the network.
Parameters
- This macro has no parameters
Return value
ConnectFromLibrary
Attempts to connect the data channel to a known device on the network.
Parameters
- BYTE Mode
- BYTE Device
Return value
ConnectToAddress
Attempts to connect the data channel to a specific device address on the network.
Parameters
- <- STRING Address
- This parameter may be returned back to the caller
Return value
GetSignalLevel
Returns the signal strength of the last signal received
Parameters
- This macro has no parameters
Return value
ExitCommandMode
Returns from command mode to allow data to be sent and received
Parameters
- This macro has no parameters
Return value
- This call does not return a value
ReadAddressFromBuffer
Reads a byte from a 16-bit Zigbee device address
Parameters
- BYTE Device
- BYTE Idx
Return value
SendATCommand
Transmits a string of values to the Zigbee module.
Parameters
- <- STRING Command
- Transmits a command to the Zigbee module followed by a carriage return
- This parameter may be returned back to the caller
Return value
- This call does not return a value
ScanNetwork
Scans the local network for devices and stores into a local device array. Mode = 0 store device names, mode = 1 store device addresses. Returns the number of devices found.
Parameters
- BYTE Mode
Return value
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.
Parameters
- BYTE Logging
Return value
ReceiveChar
Attempt to receive a byte from the Zigbee module.
Parameters
- BYTE nTimeout
Return value
Simulation macro reference
This component does not contain any simulation macros
Property reference
Device Name
This property is of type Line of text and can be referenced with the variable name dev_name.
String of characters used to allow the Zigbee node to use the name addressing mode of operation.
Can be left blank if name addressing is not being used.
Zigbee Mode
This property is of type Fixed list of ints and can be referenced with the variable name zig_mode.
Specifies the functionality of the Zigbee node.
Coordinator - Must be used with a Coordinator Zigbee E-Block EB051C, Responsible for starting the network and assigning addresses.
Router - Must be used with a Router / End Node E-Block EB051R, Responsible for forwarding / repeating packets on the network.
End Device - Must be used with a Router / End Node E-Block EB051R, Capable of low power operation.
Auto ID
This property is of type True or false and can be referenced with the variable name auto_id.
Automatically generate a PAN ID
PAN ID
This property is of type Line of text and can be referenced with the variable name pan_id.
Assigns a Personal Area Network Identifier code to the Zigbee node.
Random / Search - Scans the local area for Zigbee PAN networks and joins the existing network, otherwise a random value is chosen.
Preset - Assigns a preset PAN ID to the Zigbee node, Must be between 0x0 and 0x3FFF.
Node Join Time
This property is of type Fixed list of ints and can be referenced with the variable name join_time.
Length of time in seconds where nodes are allowed to join the network.
Infinte - Nodes are always allowed to join the network.
Preset - Nodes are only allowed to join the network for a specific amount of time.
Note: Join time not available for End Device nodes.
Max Hops
This property is of type Signed integer and can be referenced with the variable name max_hops.
Specifies the maximum number of retransmits for a Broadcast transmission.
Sleep Buffer Time
This property is of type Fixed list of ints and can be referenced with the variable name sleep_buffer.
Length of time to buffer packets for sleeping or powered down nodes. This value must be consistent throughout the Zigbee network.
Default - Assigns the maximum buffer time of 28 seconds.
Preset - Allows for a custom sleep time of 0.32 - 28 seconds.
UART Channel
This property is of type Fixed list of ints and can be referenced with the variable name Channel.
UART peripheral used to communicate with the Zigbee module
RX Pin
This property is of type Single digital pin and can be referenced with the variable name rx_pin.
UART Receive Pin
TX Pin
This property is of type Single digital pin and can be referenced with the variable name tx_pin.
UART Transmit Pin
Sleep Pin
This property is of type Single digital pin and can be referenced with the variable name pin_sleep.
Zigbee Sleep Control Pin
Flow Control
This property is of type True or false and can be referenced with the variable name flow_control.
Determines if the UART communications has additional flow control enabled.
RTS Pin
This property is of type Single digital pin and can be referenced with the variable name pin_rts.
Request to send flow control pin
CTS Pin
This property is of type Single digital pin and can be referenced with the variable name pin_cts.
Clear to send flow control pin
0x0B
This property is of type True or false and can be referenced with the variable name chan_0.
Determines if channel will be scanned
0x0C
This property is of type True or false and can be referenced with the variable name chan_1.
Determines if channel will be scanned
0x0D
This property is of type True or false and can be referenced with the variable name chan_2.
Determines if channel will be scanned
0x0E
This property is of type True or false and can be referenced with the variable name chan_3.
Determines if channel will be scanned
0x0F
This property is of type True or false and can be referenced with the variable name chan_4.
Determines if channel will be scanned
0x10
This property is of type True or false and can be referenced with the variable name chan_5.
Determines if channel will be scanned
0x11
This property is of type True or false and can be referenced with the variable name chan_6.
Determines if channel will be scanned
0x12
This property is of type True or false and can be referenced with the variable name chan_7.
Determines if channel will be scanned
0x13
This property is of type True or false and can be referenced with the variable name chan_8.
Determines if channel will be scanned
0x14
This property is of type True or false and can be referenced with the variable name chan_9.
Determines if channel will be scanned
0x15
This property is of type True or false and can be referenced with the variable name chan_10.
Determines if channel will be scanned
0x16
This property is of type True or false and can be referenced with the variable name chan_11.
Determines if channel will be scanned
0x17
This property is of type True or false and can be referenced with the variable name chan_12.
Determines if channel will be scanned
0x18
This property is of type True or false and can be referenced with the variable name chan_13.
Determines if channel will be scanned
0x19
This property is of type True or false and can be referenced with the variable name chan_14.
Determines if channel will be scanned
0x1A
This property is of type True or false and can be referenced with the variable name chan_15.
Determines if channel will be scanned
Scan Duration
This property is of type Signed integer and can be referenced with the variable name scan_duration.
Configures the length of time to scan each channel for network activity. The overall time for the entire channel scan is shown as channel scan time.
Total Scan Time (ms)
This property is of type Signed integer and can be referenced with the variable name scan_total.
The total amount of time that it will take to perform a complete RF channel scan based on the selected scan channels and duration.
Label
This property is of type Line of text and can be referenced with the variable name label.
No additional information
