Jump to content

Component: Zigbee (EB051, XBEE) (XBEE) (Wireless): Difference between revisions

From Flowcode Help

SteveT (talk | contribs)

4 user groups
6,426 edits
XML import - Pre 8.0 release
 
m Text replacement - "style="background-color:#EAE1EA;"" to "class="mtx-class-propfolder""
 
(22 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{| style="width:50%"
 
{| width="50%"
|-
|-
| width="20%" style="color: gray;" | Author
| width="20%" style="color:gray;" | Author
| Matrix Ltd.
| Matrix Ltd.
|-
|-
| width="20%" style="color: gray;" | Version
| width="20%" style="color:gray;" | Version
| 1.5 (Release)
| 1.5
|-
|-
| width="20%" style="color: gray;" | Category
| width="20%" style="color:gray;" | Category
| Wireless
| Wireless
|}
|}




==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


==[[File:Component Icon 53548cbe_cd57_471c_8ac1_3205d0e9da38.png|Image]] Zigbee (EB051, XBEE) (XBEE) component==
==Component Source Code==
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==
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Zigbee.fcfx FC_Comp_Source_Zigbee.fcfx]
''<span style="color:red;">No additional examples</span>''


Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Zigbee.fcfx FC_Comp_Source_Zigbee.fcfx]


==Downloadable macro reference==
==Detailed description==


===<span style="font-weight: normal;"><u><tt>NodeConfigureSleep</tt></u></span>===
Sets the Zigbee device sleep mode (only applicable for end node type devices) ,


'''Parameters'''


:[[Variable Types|BYTE]] ''Mode''
::1=Hibernate, 2=Doze, 4=Cyclic Sleep, 5=Cyclic Doze


:[[Variable Types|UINT]] ''Timeout''
::Time to sleep in milli seconds (ms)




'''Return value'''


:''This call does not return a value''




===<span style="font-weight: normal;"><u><tt>ReadNameFromBuffer</tt></u></span>===
Returns a byte from the 8-Byte name


'''Parameters'''


:[[Variable Types|BYTE]] ''Device''
::The Device name to collect. Range: 0-7


:[[Variable Types|BYTE]] ''Idx''
::The index position of the name. Range: 0-7




'''Return value'''


:[[Variable Types|BYTE]]




===<span style="font-weight: normal;"><u><tt>NodeWake</tt></u></span>===
Wakes up the local Zigbee module from sleep mode.


'''Parameters'''


:''This macro has no parameters''




'''Return value'''


:''This call does not return a value''




===<span style="font-weight: normal;"><u><tt>ReadATResponse</tt></u></span>===
Reads a single byte from the received AT command response.


'''Parameters'''
''No detailed description exists yet for this component''


:[[Variable Types|BYTE]] ''idx''
==Examples==
::Specified the byte index in the buffer. Range 0-15




'''Return value'''


:[[Variable Types|BYTE]]




===<span style="font-weight: normal;"><u><tt>ScanBuffer</tt></u></span>===
Returns a binary list of matched identifier names


'''Parameters'''


:[[Variable Types|STRING]] ''Compare_Str''


:[[Variable Types|BYTE]] ''Length''




'''Return value'''


:[[Variable Types|BYTE]]




===<span style="font-weight: normal;"><u><tt>SendChar</tt></u></span>===
Transmits a byte value to the Zigbee module.


'''Parameters'''


:[[Variable Types|BYTE]] ''Byte''
::Data byte to transmit. Range 0-255




'''Return value'''


:''This call does not return a value''




===<span style="font-weight: normal;"><u><tt>InitNetwork</tt></u></span>===
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''


''<span style="color:red;">No additional examples</span>''


===<span style="font-weight: normal;"><u><tt>ConnectToCoordinator</tt></u></span>===
Attempts to connect the data channel to the network coordinator node.


'''Parameters'''


:''This macro has no parameters''




'''Return value'''


:[[Variable Types|BYTE]]




===<span style="font-weight: normal;"><u><tt>ConnectToName</tt></u></span>===
Attempts to connect the data channel to a named device on the network.


'''Parameters'''


:[[Variable Types|<- STRING]] ''Name''
::''This parameter may be returned back to the caller''




'''Return value'''
==Macro reference==


:[[Variable Types|BYTE]]
===ConnectFromLibrary===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''ConnectFromLibrary'''
|-
| colspan="2" | Attempts to connect the data channel to a known device on the network.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Mode
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Device
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}




===<span style="font-weight: normal;"><u><tt>StoreParams</tt></u></span>===
===ConnectToAddress===
Stores the current register set into the Zigbee module's non volatile memory
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''ConnectToAddress'''
|-
| colspan="2" | Attempts to connect the data channel to a specific device address on the network.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Address
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


'''Parameters'''


:''This macro has no parameters''
===ConnectToAll===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''ConnectToAll'''
|-
| colspan="2" | Attempts to connect the data channel to all devices on the network.&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}




'''Return value'''
===ConnectToCoordinator===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''ConnectToCoordinator'''
|-
| colspan="2" | Attempts to connect the data channel to the network coordinator node.&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


:''This call does not return a value''


===ConnectToName===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''ConnectToName'''
|-
| colspan="2" | Attempts to connect the data channel to a named device on the network.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Name
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


===<span style="font-weight: normal;"><u><tt>EnterCommandMode</tt></u></span>===
Moves from data mode into command mode by sending the special characters


'''Parameters'''
===EnterCommandMode===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''EnterCommandMode'''
|-
| colspan="2" | Moves from data mode into command mode by sending the special characters&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


:''This macro has no parameters''


===ExitCommandMode===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''ExitCommandMode'''
|-
| colspan="2" | Returns from command mode to allow data to be sent and received&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


'''Return value'''


:''This call does not return a value''
===GetATResponse===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''GetATResponse'''
|-
| colspan="2" | 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.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Logging
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}




===<span style="font-weight: normal;"><u><tt>RestartNetwork</tt></u></span>===
===GetSignalLevel===
Attempts to restart the network
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''GetSignalLevel'''
|-
| colspan="2" | Returns the signal strength of the last signal received&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


'''Parameters'''


:''This macro has no parameters''
===InitNetwork===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''InitNetwork'''
|-
| colspan="2" | Initialises the Zigbee module and attempts to setup or join the network&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}




'''Return value'''
===MIAC_Module_GetData===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''MIAC_Module_GetData'''
|-
| colspan="2" | &nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Index
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


:''This call does not return a value''


===MIAC_Module_Message===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''MIAC_Module_Message'''
|-
| colspan="2" | &nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | CAN_ID
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | CMD_ID
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


===<span style="font-weight: normal;"><u><tt>ConnectToAll</tt></u></span>===
Attempts to connect the data channel to all devices on the network.


'''Parameters'''
===MIAC_Module_PushData===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''MIAC_Module_PushData'''
|-
| colspan="2" | &nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Data
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


:''This macro has no parameters''


===NodeConfigureSleep===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''NodeConfigureSleep'''
|-
| colspan="2" | Sets the Zigbee device sleep mode (only applicable for end node type devices) , &nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Mode
|-
| colspan="2" | 1=Hibernate, 2=Doze, 4=Cyclic Sleep, 5=Cyclic Doze&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Timeout
|-
| colspan="2" | Time to sleep in milli seconds (ms)&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


'''Return value'''


:[[Variable Types|BYTE]]
===NodeWake===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''NodeWake'''
|-
| colspan="2" | Wakes up the local Zigbee module from sleep mode.&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}




===<span style="font-weight: normal;"><u><tt>ConnectFromLibrary</tt></u></span>===
===ReadATResponse===
Attempts to connect the data channel to a known device on the network.
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''ReadATResponse'''
|-
| colspan="2" | Reads a single byte from the received AT command response.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | idx
|-
| colspan="2" | Specified the byte index in the buffer. Range 0-15&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


'''Parameters'''


:[[Variable Types|BYTE]] ''Mode''
===ReadAddressFromBuffer===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''ReadAddressFromBuffer'''
|-
| colspan="2" | Reads a byte from a 16-bit Zigbee device address&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Device
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Idx
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


:[[Variable Types|BYTE]] ''Device''


===ReadNameFromBuffer===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''ReadNameFromBuffer'''
|-
| colspan="2" | Returns a byte from the 8-Byte name&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Device
|-
| colspan="2" | The Device name to collect. Range: 0-7&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Idx
|-
| colspan="2" | The index position of the name. Range: 0-7&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


'''Return value'''


:[[Variable Types|BYTE]]
===ReceiveChar===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''ReceiveChar'''
|-
| colspan="2" | Attempt to receive a byte from the Zigbee module.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | nTimeout
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}




===<span style="font-weight: normal;"><u><tt>ConnectToAddress</tt></u></span>===
===RestartNetwork===
Attempts to connect the data channel to a specific device address on the network.
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''RestartNetwork'''
|-
| colspan="2" | Attempts to restart the network&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


'''Parameters'''


:[[Variable Types|<- STRING]] ''Address''
===ScanBuffer===
::''This parameter may be returned back to the caller''
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''ScanBuffer'''
|-
| colspan="2" | Returns a binary list of matched identifier names&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Compare_Str
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Length
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}




'''Return value'''
===ScanNetwork===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''ScanNetwork'''
|-
| colspan="2" | 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.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Mode
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


:[[Variable Types|BYTE]]


===SendATCommand===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''SendATCommand'''
|-
| colspan="2" | Transmits a string of values to the Zigbee module.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Command
|-
| colspan="2" | Transmits a command to the Zigbee module followed by a carriage return&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


===<span style="font-weight: normal;"><u><tt>GetSignalLevel</tt></u></span>===
Returns the signal strength of the last signal received


'''Parameters'''
===SendChar===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''SendChar'''
|-
| colspan="2" | Transmits a byte value to the Zigbee module.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Byte
|-
| colspan="2" | Data byte to transmit. Range 0-255&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


:''This macro has no parameters''
'''Return value'''
:[[Variable Types|BYTE]]


 
===StoreParams===
===<span style="font-weight: normal;"><u><tt>ExitCommandMode</tt></u></span>===
{| class="mtx-class-macrotable wikitable"
Returns from command mode to allow data to be sent and received
|-
 
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
'''Parameters'''
| width="90%" class="mtx-class-macrohead" | '''StoreParams'''
 
|-
:''This macro has no parameters''
| colspan="2" | Stores the current register set into the Zigbee module's non volatile memory&nbsp;
 
|-
 
|-
'''Return value'''
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
:''This call does not return a value''
|}
 
 
===<span style="font-weight: normal;"><u><tt>ReadAddressFromBuffer</tt></u></span>===
Reads a byte from a 16-bit Zigbee device address
 
'''Parameters'''
 
:[[Variable Types|BYTE]] ''Device''
 
:[[Variable Types|BYTE]] ''Idx''
 
 
'''Return value'''
 
:[[Variable Types|BYTE]]
 
 
===<span style="font-weight: normal;"><u><tt>SendATCommand</tt></u></span>===
Transmits a string of values to the Zigbee module.
 
'''Parameters'''
 
:[[Variable Types|<- 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''
 
 
===<span style="font-weight: normal;"><u><tt>ScanNetwork</tt></u></span>===
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'''
 
:[[Variable Types|BYTE]] ''Mode''
 
 
'''Return value'''
 
:[[Variable Types|BYTE]]
 
 
===<span style="font-weight: normal;"><u><tt>GetATResponse</tt></u></span>===
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'''
 
:[[Variable Types|BYTE]] ''Logging''
 
 
'''Return value'''
 
:[[Variable Types|BYTE]]
 
 
===<span style="font-weight: normal;"><u><tt>ReceiveChar</tt></u></span>===
Attempt to receive a byte from the Zigbee module.
 
'''Parameters'''
 
:[[Variable Types|BYTE]] ''nTimeout''
 
 
'''Return value'''
 
:[[Variable Types|BYTE]]
 
 
 
==Simulation macro reference==
 
''This component does not contain any simulation macros''




==Property reference==
==Property reference==
<span style="font-weight: normal;"><u>Device Name</u></span>


This property is of type ''Line of text'' and can be referenced with the variable name ''dev_name''.
{| class="mtx-class-macrotable wikitable"
 
|-
String of characters used to allow the Zigbee node to use the name addressing mode of operation.  
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
 
| width="90%" class="mtx-class-macrohead" | '''Properties'''  
Can be left blank if name addressing is not being used.
|-
 
|-
<span style="font-weight: normal;"><u>Zigbee Mode</u></span>
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
 
| width="90%" | Device Name
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''zig_mode''.
|-
 
| colspan="2" | 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.&nbsp;
Specifies the functionality of the Zigbee node.
|-
 
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
Coordinator - Must be used with a Coordinator Zigbee E-Block EB051C, Responsible for starting the network and assigning addresses.
| width="90%" | Zigbee Mode
 
|-
Router - Must be used with a Router / End Node E-Block EB051R, Responsible for forwarding / repeating packets on the network.
| colspan="2" | 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.&nbsp;
 
|-
End Device - Must be used with a Router / End Node E-Block EB051R, Capable of low power operation.
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
| width="90%" | Auto ID
<span style="font-weight: normal;"><u>Auto ID</u></span>
|-
 
| colspan="2" | Automatically generate a PAN ID &nbsp;
This property is of type ''True or false'' and can be referenced with the variable name ''auto_id''.
|-
 
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
Automatically generate a PAN ID
| width="90%" | PAN ID
 
|-
<span style="font-weight: normal;"><u>PAN ID</u></span>
| colspan="2" | 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.&nbsp;
 
|-
This property is of type ''Line of text'' and can be referenced with the variable name ''pan_id''.
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
| width="90%" | Node Join Time
Assigns a Personal Area Network Identifier code to the Zigbee node.
|-
 
| colspan="2" | 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. &nbsp;
Random / Search - Scans the local area for Zigbee PAN networks and joins the existing network, otherwise a random value is chosen.
|-
 
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
Preset - Assigns a preset PAN ID to the Zigbee node, Must be between 0x0 and 0x3FFF.
| width="90%" | Max Hops
 
|-
<span style="font-weight: normal;"><u>Node Join Time</u></span>
| colspan="2" | Specifies the maximum number of retransmits for a Broadcast transmission.&nbsp;
 
|-
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''join_time''.
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
| width="90%" | Sleep Buffer Time
Length of time in seconds where nodes are allowed to join the network.
|-
 
| colspan="2" | 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.&nbsp;
Infinte - Nodes are always allowed to join the network.
|-
 
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
Preset - Nodes are only allowed to join the network for a specific amount of time.
| width="90%" class="mtx-class-propfolder" | Connections
 
|-
Note: Join time not available for End Device nodes.
|-
 
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
<span style="font-weight: normal;"><u>Max Hops</u></span>
| width="90%" | Channel
 
|-
This property is of type ''Signed integer'' and can be referenced with the variable name ''max_hops''.
| colspan="2" | UART Channel selector Software channels are bit banged using generic I/O pins but are not as reliable as hardware channels. Hardware channels use the selected peripheral on-board the target microcontroller.&nbsp;
 
|-
Specifies the maximum number of retransmits for a Broadcast transmission.
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 
| width="90%" | TX
<span style="font-weight: normal;"><u>Sleep Buffer Time</u></span>
|-
 
| colspan="2" | Pin to be used for Transmit data&nbsp;
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''sleep_buffer''.
|-
 
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
Length of time to buffer packets for sleeping or powered down nodes. This value must be consistent throughout the Zigbee network.
| width="90%" | RX
 
|-
Default - Assigns the maximum buffer time of 28 seconds.
| colspan="2" | Pin to be used for Receive data&nbsp;
 
|-
Preset - Allows for a custom sleep time of 0.32 - 28 seconds.
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
| width="90%" | Baud Options
<span style="font-weight: normal;"><u>Channel</u></span>
|-
 
| colspan="2" | Baud rate option selector&nbsp;
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_uart::CHANNEL''.
|-
 
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
UART Channel selector
| width="90%" | Baud Rate
 
|-
Software channels are bit banged using generic I/O pins but are not as reliable as hardware channels.
| colspan="2" | &nbsp;
 
|-
Hardware channels use the selected peripheral on-board the target microcontroller.
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
| width="90%" | Use Flow Control
<span style="font-weight: normal;"><u>TX</u></span>
|-
 
| colspan="2" | Flow Control (Handshake) enable or disable.    On: Two I/O pins are used to control the flow of data in and out of the device.    Off: Flow control is disabled.&nbsp;
This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_uart::TX''.
|-
 
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
Pin to be used for Transmit data
| width="90%" | RTS
 
|-
<span style="font-weight: normal;"><u>RX</u></span>
| colspan="2" | Pin to be used for Request To Send handshake function Output from target micro to inform remote device we are ready to receive data. Low = Ready to receive data High = Not ready to receive data&nbsp;
 
|-
This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_uart::RX''.
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 
| width="90%" | CTS
Pin to be used for Receive data
|-
 
| colspan="2" | Pin to be used for Clear To Send handshake function. Input to target micro to inform when the remote device is ready to transmit data. Low = Ready to transmit data High = Not ready to transmit data&nbsp;
<span style="font-weight: normal;"><u>Baud Options</u></span>
|-
 
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_uart::BAUD_LIST''.
| width="90%" | Sleep Pin
 
|-
Baud rate option selector
| colspan="2" | Zigbee Sleep Control Pin&nbsp;
 
|-
<span style="font-weight: normal;"><u>Baud Rate</u></span>
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
 
| width="90%" class="mtx-class-propfolder" | Scan Channels
This property is of type ''Signed integer'' and can be referenced with the variable name ''cal_uart::BAUD''.
|-
 
|-
''<span style="color:red;">No additional information</span>''
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
| width="90%" | 0x0B
 
|-
 
| colspan="2" | Determines if channel will be scanned&nbsp;
<span style="font-weight: normal;"><u>Use Flow Control</u></span>
|-
 
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_uart::FLOWEN''.
| width="90%" | 0x0C
 
|-
Flow Control (Handshake) enable or disable.
| colspan="2" | Determines if channel will be scanned&nbsp;
 
|-
     On: Two I/O pins are used to control the flow of data in and out of the device.
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
| width="90%" | 0x0D
     Off: Flow control is disabled.
|-
 
| colspan="2" | Determines if channel will be scanned&nbsp;
<span style="font-weight: normal;"><u>RTS</u></span>
|-
 
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_uart::RTS''.
| width="90%" | 0x0E
 
|-
Pin to be used for Request To Send handshake function
| colspan="2" | Determines if channel will be scanned&nbsp;
 
|-
Output from target micro to inform remote device we are ready to receive data.
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
| width="90%" | 0x0F
Low = Ready to receive data
|-
 
| colspan="2" | Determines if channel will be scanned&nbsp;
High = Not ready to receive data
|-
 
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
<span style="font-weight: normal;"><u>CTS</u></span>
| width="90%" | 0x10
 
|-
This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_uart::CTS''.
| colspan="2" | Determines if channel will be scanned&nbsp;
 
|-
Pin to be used for Clear To Send handshake function.
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
| width="90%" | 0x11
Input to target micro to inform when the remote device is ready to transmit data.
|-
 
| colspan="2" | Determines if channel will be scanned&nbsp;
Low = Ready to transmit data
|-
 
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
High = Not ready to transmit data
| width="90%" | 0x12
 
|-
<span style="font-weight: normal;"><u>Sleep Pin</u></span>
| colspan="2" | Determines if channel will be scanned&nbsp;
 
|-
This property is of type ''Single digital pin'' and can be referenced with the variable name ''pin_sleep''.
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
| width="90%" | 0x13
Zigbee Sleep Control Pin
|-
 
| colspan="2" | Determines if channel will be scanned&nbsp;
<span style="font-weight: normal;"><u>0x0B</u></span>
|-
 
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
This property is of type ''True or false'' and can be referenced with the variable name ''chan_0''.
| width="90%" | 0x14
 
|-
Determines if channel will be scanned
| colspan="2" | Determines if channel will be scanned&nbsp;
 
|-
<span style="font-weight: normal;"><u>0x0C</u></span>
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
| width="90%" | 0x15
This property is of type ''True or false'' and can be referenced with the variable name ''chan_1''.
|-
 
| colspan="2" | Determines if channel will be scanned&nbsp;
Determines if channel will be scanned
|-
 
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
<span style="font-weight: normal;"><u>0x0D</u></span>
| width="90%" | 0x16
 
|-
This property is of type ''True or false'' and can be referenced with the variable name ''chan_2''.
| colspan="2" | Determines if channel will be scanned&nbsp;
 
|-
Determines if channel will be scanned
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
| width="90%" | 0x17
<span style="font-weight: normal;"><u>0x0E</u></span>
|-
 
| colspan="2" | Determines if channel will be scanned&nbsp;
This property is of type ''True or false'' and can be referenced with the variable name ''chan_3''.
|-
 
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
Determines if channel will be scanned
| width="90%" | 0x18
 
|-
<span style="font-weight: normal;"><u>0x0F</u></span>
| colspan="2" | Determines if channel will be scanned&nbsp;
 
|-
This property is of type ''True or false'' and can be referenced with the variable name ''chan_4''.
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
| width="90%" | 0x19
Determines if channel will be scanned
|-
 
| colspan="2" | Determines if channel will be scanned&nbsp;
<span style="font-weight: normal;"><u>0x10</u></span>
|-
 
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
This property is of type ''True or false'' and can be referenced with the variable name ''chan_5''.
| width="90%" | 0x1A
 
|-
Determines if channel will be scanned
| colspan="2" | Determines if channel will be scanned&nbsp;
 
|-
<span style="font-weight: normal;"><u>0x11</u></span>
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 
| width="90%" | Scan Duration
This property is of type ''True or false'' and can be referenced with the variable name ''chan_6''.
|-
 
| colspan="2" | 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.&nbsp;
Determines if channel will be scanned
|-
 
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
<span style="font-weight: normal;"><u>0x12</u></span>
| width="90%" | Total Scan Time (ms)
 
|-
This property is of type ''True or false'' and can be referenced with the variable name ''chan_7''.
| colspan="2" | The total amount of time that it will take to perform a complete RF channel scan based on the selected scan channels and duration.&nbsp;
 
|-
Determines if channel will be scanned
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
 
| width="90%" class="mtx-class-propfolder" | Simulation
<span style="font-weight: normal;"><u>0x13</u></span>
|-
 
|-
This property is of type ''True or false'' and can be referenced with the variable name ''chan_8''.
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
 
| width="90%" | Label
Determines if channel will be scanned
|-
 
| colspan="2" | &nbsp;
<span style="font-weight: normal;"><u>0x14</u></span>
|-
 
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
This property is of type ''True or false'' and can be referenced with the variable name ''chan_9''.
| width="90%" | Scope Traces
 
|-
Determines if channel will be scanned
| colspan="2" | Selects if the scope traces are automatically added to the data recorder window or not.    Simulation - draws an approximation of the UART data onto the scope trace.    ICT - sets up the scope trace for incoming data and adds UART packet decoding at the correct BAUD.&nbsp;
 
|-
<span style="font-weight: normal;"><u>0x15</u></span>
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
| width="90%" | Console Data
This property is of type ''True or false'' and can be referenced with the variable name ''chan_10''.
|-
 
| colspan="2" | Selects if the console data is automatically generated or not&nbsp;
Determines if channel will be scanned
|-
 
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
<span style="font-weight: normal;"><u>0x16</u></span>
| width="90%" | Console Columns
 
|-
This property is of type ''True or false'' and can be referenced with the variable name ''chan_11''.
| colspan="2" | Number of characters that can be displayed on a single line of the console.&nbsp;
 
|-
Determines if channel will be scanned
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
| width="90%" | Data Source
<span style="font-weight: normal;"><u>0x17</u></span>
|-
 
| colspan="2" | Simulation data source used to allow the component to connect to various remote devices    Nothing - Simulation data is ignored    COM port - Routes the communication data to and from a physical or virtual COM port     API - Routes the communication data via a data API component on the Panel.&nbsp;
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>
 
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>
 
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>
 
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>
 
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>
 
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>
 
This property is of type ''Line of text'' and can be referenced with the variable name ''label''.
 
''<span style="color:red;">No additional information</span>''
 
 
 
<span style="font-weight: normal;"><u>Scope Traces</u></span>
 
This property is of type ''True or false'' and can be referenced with the variable name ''cal_uart::ScopeTraces''.
 
Selects if the scope traces are automatically added to the data recorder window or not.
 
     Simulation - draws an approximation of the UART data onto the scope trace.
 
     ICT - sets up the scope trace for incoming data and adds UART packet decoding at the correct BAUD.
 
<span style="font-weight: normal;"><u>Console Data</u></span>
 
This property is of type ''True or false'' and can be referenced with the variable name ''cal_uart::ConsoleData''.
 
Selects if the console data is automatically generated or not
 
<span style="font-weight: normal;"><u>Console Columns</u></span>
 
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''cal_uart::ConsoleColumns''.
 
Number of characters that can be displayed on a single line of the console.
 
<span style="font-weight: normal;"><u>Data Source</u></span>
 
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_uart::DataSource''.
 
Simulation data source used to allow the component to connect to various remote devices
 
     Nothing - Simulation data is ignored
 
     COM port - Routes the communication data to and from a physical or virtual COM port  
 
    Injector - Routes the communication data via a data injector component on the Panel.

Latest revision as of 14:37, 13 July 2026

Author Matrix Ltd.
Version 1.5
Category Wireless


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

Component Source Code

Please click here to download the component source project: FC_Comp_Source_Zigbee.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_Zigbee.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples







Macro reference

ConnectFromLibrary

ConnectFromLibrary
Attempts to connect the data channel to a known device on the network. 
- BYTE Mode
 
- BYTE Device
 
- BYTE Return


ConnectToAddress

ConnectToAddress
Attempts to connect the data channel to a specific device address on the network. 
- STRING Address
 
- BYTE Return


ConnectToAll

ConnectToAll
Attempts to connect the data channel to all devices on the network. 
- BYTE Return


ConnectToCoordinator

ConnectToCoordinator
Attempts to connect the data channel to the network coordinator node. 
- BYTE Return


ConnectToName

ConnectToName
Attempts to connect the data channel to a named device on the network. 
- STRING Name
 
- BYTE Return


EnterCommandMode

EnterCommandMode
Moves from data mode into command mode by sending the special characters 
- VOID Return


ExitCommandMode

ExitCommandMode
Returns from command mode to allow data to be sent and received 
- VOID Return


GetATResponse

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


GetSignalLevel

GetSignalLevel
Returns the signal strength of the last signal received 
- BYTE Return


InitNetwork

InitNetwork
Initialises the Zigbee module and attempts to setup or join the network 
- VOID Return


MIAC_Module_GetData

MIAC_Module_GetData
 
- BYTE Index
 
- BYTE Return


MIAC_Module_Message

MIAC_Module_Message
 
- UINT CAN_ID
 
- UINT CMD_ID
 
- BYTE Return


MIAC_Module_PushData

MIAC_Module_PushData
 
- BYTE Data
 
- VOID Return


NodeConfigureSleep

NodeConfigureSleep
Sets the Zigbee device sleep mode (only applicable for end node type devices) ,  
- BYTE Mode
1=Hibernate, 2=Doze, 4=Cyclic Sleep, 5=Cyclic Doze 
- UINT Timeout
Time to sleep in milli seconds (ms) 
- VOID Return


NodeWake

NodeWake
Wakes up the local Zigbee module from sleep mode. 
- VOID Return


ReadATResponse

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


ReadAddressFromBuffer

ReadAddressFromBuffer
Reads a byte from a 16-bit Zigbee device address 
- BYTE Device
 
- BYTE Idx
 
- BYTE Return


ReadNameFromBuffer

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


ReceiveChar

ReceiveChar
Attempt to receive a byte from the Zigbee module. 
- BYTE nTimeout
 
- BYTE Return


RestartNetwork

RestartNetwork
Attempts to restart the network 
- VOID Return


ScanBuffer

ScanBuffer
Returns a binary list of matched identifier names 
- STRING Compare_Str
 
- BYTE Length
 
- BYTE Return


ScanNetwork

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. 
- BYTE Mode
 
- BYTE Return


SendATCommand

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


SendChar

SendChar
Transmits a byte value to the Zigbee module. 
- BYTE Byte
Data byte to transmit. Range 0-255 
- VOID Return


StoreParams

StoreParams
Stores the current register set into the Zigbee module's non volatile memory 
- VOID Return


Property reference

Properties
Device 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
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
Automatically generate a PAN ID  
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
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
Specifies the maximum number of retransmits for a Broadcast transmission. 
Sleep Buffer Time
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. 
Connections
Channel
UART Channel selector Software channels are bit banged using generic I/O pins but are not as reliable as hardware channels. Hardware channels use the selected peripheral on-board the target microcontroller. 
TX
Pin to be used for Transmit data 
RX
Pin to be used for Receive data 
Baud Options
Baud rate option selector 
Baud Rate
 
Use Flow Control
Flow Control (Handshake) enable or disable. On: Two I/O pins are used to control the flow of data in and out of the device. Off: Flow control is disabled. 
RTS
Pin to be used for Request To Send handshake function Output from target micro to inform remote device we are ready to receive data. Low = Ready to receive data High = Not ready to receive data 
CTS
Pin to be used for Clear To Send handshake function. Input to target micro to inform when the remote device is ready to transmit data. Low = Ready to transmit data High = Not ready to transmit data 
Sleep Pin
Zigbee Sleep Control Pin 
Scan Channels
0x0B
Determines if channel will be scanned 
0x0C
Determines if channel will be scanned 
0x0D
Determines if channel will be scanned 
0x0E
Determines if channel will be scanned 
0x0F
Determines if channel will be scanned 
0x10
Determines if channel will be scanned 
0x11
Determines if channel will be scanned 
0x12
Determines if channel will be scanned 
0x13
Determines if channel will be scanned 
0x14
Determines if channel will be scanned 
0x15
Determines if channel will be scanned 
0x16
Determines if channel will be scanned 
0x17
Determines if channel will be scanned 
0x18
Determines if channel will be scanned 
0x19
Determines if channel will be scanned 
0x1A
Determines if channel will be scanned 
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)
The total amount of time that it will take to perform a complete RF channel scan based on the selected scan channels and duration. 
Simulation
Label
 
Scope Traces
Selects if the scope traces are automatically added to the data recorder window or not. Simulation - draws an approximation of the UART data onto the scope trace. ICT - sets up the scope trace for incoming data and adds UART packet decoding at the correct BAUD. 
Console Data
Selects if the console data is automatically generated or not 
Console Columns
Number of characters that can be displayed on a single line of the console. 
Data Source
Simulation data source used to allow the component to connect to various remote devices Nothing - Simulation data is ignored COM port - Routes the communication data to and from a physical or virtual COM port API - Routes the communication data via a data API component on the Panel. 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Zigbee_(EB051,_XBEE)_(XBEE)_(Wireless)&oldid=48290"