Difference between revisions of "Component: Zigbee (BL0152) (E-blocks 2)"

From Flowcode Help
Jump to navigationJump to search
Line 17: Line 17:
 
==Component Source Code==
 
==Component Source Code==
  
−
Please click here for the component source code: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_EBlocks2_Zigbee_BL0152_2d.fcfx FC_Comp_Source_EBlocks2_Zigbee_BL0152_2d.fcfx]
+
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_EBlocks2_Zigbee_BL0152_2d.fcfx FC_Comp_Source_EBlocks2_Zigbee_BL0152_2d.fcfx]
  
 
==Detailed description==
 
==Detailed description==
 +
 +
  
  
Line 28: Line 30:
  
 
==Examples==
 
==Examples==
 +
 +
  
  
Line 36: Line 40:
  
 
==Macro reference==
 
==Macro reference==
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''NodeConfigureSleep'''
 +
|-
 +
| colspan="2" | Sets the Zigbee device sleep mode (only applicable for end node type devices) ,  
 +
|-
 +
|-
 +
| 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 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Timeout
 +
|-
 +
| colspan="2" | Time to sleep in milli seconds (ms) 
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadNameFromBuffer'''
 +
|-
 +
| colspan="2" | Returns a byte from the 8-Byte name 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Device
 +
|-
 +
| colspan="2" | The Device name to collect. Range: 0-7 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Idx
 +
|-
 +
| colspan="2" | The index position of the name. Range: 0-7 
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''NodeWake'''
 +
|-
 +
| colspan="2" | Wakes up the local Zigbee module from sleep mode. 
 +
|-
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadATResponse'''
 +
|-
 +
| colspan="2" | Reads a single byte from the received AT command response. 
 +
|-
 +
|-
 +
| 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 
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ScanBuffer'''
 +
|-
 +
| colspan="2" | Returns a binary list of matched identifier names 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | Compare_Str
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Length
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SendChar'''
 +
|-
 +
| colspan="2" | Transmits a byte value to the Zigbee module. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Byte
 +
|-
 +
| colspan="2" | Data byte to transmit. Range 0-255 
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''InitNetwork'''
 +
|-
 +
| colspan="2" | Initialises the Zigbee module and attempts to setup or join the network 
 +
|-
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ConnectToCoordinator'''
 +
|-
 +
| colspan="2" | Attempts to connect the data channel to the network coordinator node. 
 +
|-
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ConnectToName'''
 +
|-
 +
| colspan="2" | Attempts to connect the data channel to a named device on the network. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | Name
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''EnterCommandMode'''
 +
|-
 +
| colspan="2" | Moves from data mode into command mode by sending the special characters 
 +
|-
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''RestartNetwork'''
 +
|-
 +
| colspan="2" | Attempts to restart the network 
 +
|-
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''StoreParams'''
 +
|-
 +
| colspan="2" | Stores the current register set into the Zigbee module's non volatile memory 
 +
|-
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ConnectToAll'''
 +
|-
 +
| colspan="2" | Attempts to connect the data channel to all devices on the network. 
 +
|-
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ConnectFromLibrary'''
 +
|-
 +
| colspan="2" | Attempts to connect the data channel to a known device on the network. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Mode
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Device
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ConnectToAddress'''
 +
|-
 +
| colspan="2" | Attempts to connect the data channel to a specific device address on the network. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | Address
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetSignalLevel'''
 +
|-
 +
| colspan="2" | Returns the signal strength of the last signal received 
 +
|-
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ExitCommandMode'''
 +
|-
 +
| colspan="2" | Returns from command mode to allow data to be sent and received 
 +
|-
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadAddressFromBuffer'''
 +
|-
 +
| colspan="2" | Reads a byte from a 16-bit Zigbee device address 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Device
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Idx
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SendATCommand'''
 +
|-
 +
| colspan="2" | Transmits a string of values to the Zigbee module. 
 +
|-
 +
|-
 +
| 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 
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Mode
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Logging
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReceiveChar'''
 +
|-
 +
| colspan="2" | Attempt to receive a byte from the Zigbee module. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | nTimeout
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
 +
 +
==Property reference==
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
 +
| width="90%" | Device Name
 +
|-
 +
| 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. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Zigbee Mode
 +
|-
 +
| 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. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | Auto ID
 +
|-
 +
| colspan="2" | Automatically generate a PAN ID  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
 +
| width="90%" | PAN ID
 +
|-
 +
| 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. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Node Join Time
 +
|-
 +
| 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.  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 +
| width="90%" | Max Hops
 +
|-
 +
| colspan="2" | Specifies the maximum number of retransmits for a Broadcast transmission. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Sleep Buffer Time
 +
|-
 +
| 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. 
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Channel
 +
|-
 +
| 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. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 +
| width="90%" | TX
 +
|-
 +
| colspan="2" | Pin to be used for Transmit data 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | TX Remap Pin
 +
|-
 +
| colspan="2" | Allows the hardware transmit pin to be configured from a list of available pins based on your target device, 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 +
| width="90%" | RX
 +
|-
 +
| colspan="2" | Pin to be used for Receive data 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | RX Remap Pin
 +
|-
 +
| colspan="2" | Allows the hardware receive pin to be configured from a list of available pins based on your target device, 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Baud Options
 +
|-
 +
| colspan="2" | Baud rate option selector 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 +
| width="90%" | Baud Rate
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Use Flow Control
 +
|-
 +
| 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. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 +
| width="90%" | RTS
 +
|-
 +
| 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 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 +
| width="90%" | CTS
 +
|-
 +
| 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 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 +
| width="90%" | Sleep Pin
 +
|-
 +
| colspan="2" | Zigbee Sleep Control Pin 
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Scan Channels
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | 0x0B
 +
|-
 +
| colspan="2" | Determines if channel will be scanned 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | 0x0C
 +
|-
 +
| colspan="2" | Determines if channel will be scanned 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | 0x0D
 +
|-
 +
| colspan="2" | Determines if channel will be scanned 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | 0x0E
 +
|-
 +
| colspan="2" | Determines if channel will be scanned 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | 0x0F
 +
|-
 +
| colspan="2" | Determines if channel will be scanned 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | 0x10
 +
|-
 +
| colspan="2" | Determines if channel will be scanned 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | 0x11
 +
|-
 +
| colspan="2" | Determines if channel will be scanned 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | 0x12
 +
|-
 +
| colspan="2" | Determines if channel will be scanned 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | 0x13
 +
|-
 +
| colspan="2" | Determines if channel will be scanned 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | 0x14
 +
|-
 +
| colspan="2" | Determines if channel will be scanned 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | 0x15
 +
|-
 +
| colspan="2" | Determines if channel will be scanned 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | 0x16
 +
|-
 +
| colspan="2" | Determines if channel will be scanned 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | 0x17
 +
|-
 +
| colspan="2" | Determines if channel will be scanned 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | 0x18
 +
|-
 +
| colspan="2" | Determines if channel will be scanned 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | 0x19
 +
|-
 +
| colspan="2" | Determines if channel will be scanned 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | 0x1A
 +
|-
 +
| colspan="2" | Determines if channel will be scanned 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 +
| width="90%" | Scan Duration
 +
|-
 +
| 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. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 +
| width="90%" | Total Scan Time (ms)
 +
|-
 +
| 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. 
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
 +
| width="90%" | Label
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | Scope Traces
 +
|-
 +
| 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. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | Console Data
 +
|-
 +
| colspan="2" | Selects if the console data is automatically generated or not 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | Console Columns
 +
|-
 +
| colspan="2" | Number of characters that can be displayed on a single line of the console. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Data Source
 +
|-
 +
| 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. 
 +
|}==Macro reference==
  
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"

Revision as of 15:14, 20 January 2023

Author Matrix TSL
Version 1.0
Category E-blocks 2


Zigbee component

Component Source Code

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

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

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


Fc9-comp-macro.png ReadNameFromBuffer
Returns a byte from the 8-Byte name 
Fc9-u8-icon.png - BYTE Device
The Device name to collect. Range: 0-7 
Fc9-u8-icon.png - BYTE Idx
The index position of the name. Range: 0-7 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png NodeWake
Wakes up the local Zigbee module from sleep mode. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ReadATResponse
Reads a single byte from the received AT command response. 
Fc9-u8-icon.png - BYTE idx
Specified the byte index in the buffer. Range 0-15 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png ScanBuffer
Returns a binary list of matched identifier names 
Fc9-string-icon.png - STRING Compare_Str
 
Fc9-u8-icon.png - BYTE Length
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png SendChar
Transmits a byte value to the Zigbee module. 
Fc9-u8-icon.png - BYTE Byte
Data byte to transmit. Range 0-255 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png InitNetwork
Initialises the Zigbee module and attempts to setup or join the network 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ConnectToCoordinator
Attempts to connect the data channel to the network coordinator node. 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png ConnectToName
Attempts to connect the data channel to a named device on the network. 
Fc9-string-icon.png - STRING Name
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png EnterCommandMode
Moves from data mode into command mode by sending the special characters 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png RestartNetwork
Attempts to restart the network 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png StoreParams
Stores the current register set into the Zigbee module's non volatile memory 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ConnectToAll
Attempts to connect the data channel to all devices on the network. 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png ConnectFromLibrary
Attempts to connect the data channel to a known device on the network. 
Fc9-u8-icon.png - BYTE Mode
 
Fc9-u8-icon.png - BYTE Device
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png ConnectToAddress
Attempts to connect the data channel to a specific device address on the network. 
Fc9-string-icon.png - STRING Address
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png GetSignalLevel
Returns the signal strength of the last signal received 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png ExitCommandMode
Returns from command mode to allow data to be sent and received 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ReadAddressFromBuffer
Reads a byte from a 16-bit Zigbee device address 
Fc9-u8-icon.png - BYTE Device
 
Fc9-u8-icon.png - BYTE Idx
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png SendATCommand
Transmits a string of values to the Zigbee module. 
Fc9-string-icon.png - STRING Command
Transmits a command to the Zigbee module followed by a carriage return 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Mode
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Logging
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png ReceiveChar
Attempt to receive a byte from the Zigbee module. 
Fc9-u8-icon.png - BYTE nTimeout
 
Fc9-u8-icon.png - BYTE Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-10-icon.png 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. 
Fc9-type-16-icon.png 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. 
Fc9-type-7-icon.png Auto ID
Automatically generate a PAN ID  
Fc9-type-10-icon.png 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. 
Fc9-type-16-icon.png 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.  
Fc9-type-14-icon.png Max Hops
Specifies the maximum number of retransmits for a Broadcast transmission. 
Fc9-type-16-icon.png 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. 
Fc9-conn-icon.png Connections
Fc9-type-16-icon.png 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. 
Fc9-type-5-icon.png TX
Pin to be used for Transmit data 
Fc9-type-16-icon.png TX Remap Pin
Allows the hardware transmit pin to be configured from a list of available pins based on your target device, 
Fc9-type-5-icon.png RX
Pin to be used for Receive data 
Fc9-type-16-icon.png RX Remap Pin
Allows the hardware receive pin to be configured from a list of available pins based on your target device, 
Fc9-type-16-icon.png Baud Options
Baud rate option selector 
Fc9-type-14-icon.png Baud Rate
 
Fc9-type-16-icon.png 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. 
Fc9-type-5-icon.png 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 
Fc9-type-5-icon.png 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 
Fc9-type-5-icon.png Sleep Pin
Zigbee Sleep Control Pin 
Fc9-conn-icon.png Scan Channels
Fc9-type-7-icon.png 0x0B
Determines if channel will be scanned 
Fc9-type-7-icon.png 0x0C
Determines if channel will be scanned 
Fc9-type-7-icon.png 0x0D
Determines if channel will be scanned 
Fc9-type-7-icon.png 0x0E
Determines if channel will be scanned 
Fc9-type-7-icon.png 0x0F
Determines if channel will be scanned 
Fc9-type-7-icon.png 0x10
Determines if channel will be scanned 
Fc9-type-7-icon.png 0x11
Determines if channel will be scanned 
Fc9-type-7-icon.png 0x12
Determines if channel will be scanned 
Fc9-type-7-icon.png 0x13
Determines if channel will be scanned 
Fc9-type-7-icon.png 0x14
Determines if channel will be scanned 
Fc9-type-7-icon.png 0x15
Determines if channel will be scanned 
Fc9-type-7-icon.png 0x16
Determines if channel will be scanned 
Fc9-type-7-icon.png 0x17
Determines if channel will be scanned 
Fc9-type-7-icon.png 0x18
Determines if channel will be scanned 
Fc9-type-7-icon.png 0x19
Determines if channel will be scanned 
Fc9-type-7-icon.png 0x1A
Determines if channel will be scanned 
Fc9-type-14-icon.png 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. 
Fc9-type-14-icon.png 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. 
Fc9-conn-icon.png Simulation
Fc9-type-10-icon.png Label
 
Fc9-type-7-icon.png 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. 
Fc9-type-7-icon.png Console Data
Selects if the console data is automatically generated or not 
Fc9-type-21-icon.png Console Columns
Number of characters that can be displayed on a single line of the console. 
Fc9-type-16-icon.png 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. 

==Macro reference==

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


Fc9-comp-macro.png ReadNameFromBuffer
Returns a byte from the 8-Byte name 
Fc9-u8-icon.png - BYTE Device
The Device name to collect. Range: 0-7 
Fc9-u8-icon.png - BYTE Idx
The index position of the name. Range: 0-7 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png NodeWake
Wakes up the local Zigbee module from sleep mode. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ReadATResponse
Reads a single byte from the received AT command response. 
Fc9-u8-icon.png - BYTE idx
Specified the byte index in the buffer. Range 0-15 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png ScanBuffer
Returns a binary list of matched identifier names 
Fc9-string-icon.png - STRING Compare_Str
 
Fc9-u8-icon.png - BYTE Length
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png SendChar
Transmits a byte value to the Zigbee module. 
Fc9-u8-icon.png - BYTE Byte
Data byte to transmit. Range 0-255 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png InitNetwork
Initialises the Zigbee module and attempts to setup or join the network 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ConnectToCoordinator
Attempts to connect the data channel to the network coordinator node. 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png ConnectToName
Attempts to connect the data channel to a named device on the network. 
Fc9-string-icon.png - STRING Name
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png EnterCommandMode
Moves from data mode into command mode by sending the special characters 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png RestartNetwork
Attempts to restart the network 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png StoreParams
Stores the current register set into the Zigbee module's non volatile memory 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ConnectToAll
Attempts to connect the data channel to all devices on the network. 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png ConnectFromLibrary
Attempts to connect the data channel to a known device on the network. 
Fc9-u8-icon.png - BYTE Mode
 
Fc9-u8-icon.png - BYTE Device
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png ConnectToAddress
Attempts to connect the data channel to a specific device address on the network. 
Fc9-string-icon.png - STRING Address
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png GetSignalLevel
Returns the signal strength of the last signal received 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png ExitCommandMode
Returns from command mode to allow data to be sent and received 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ReadAddressFromBuffer
Reads a byte from a 16-bit Zigbee device address 
Fc9-u8-icon.png - BYTE Device
 
Fc9-u8-icon.png - BYTE Idx
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png SendATCommand
Transmits a string of values to the Zigbee module. 
Fc9-string-icon.png - STRING Command
Transmits a command to the Zigbee module followed by a carriage return 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Mode
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Logging
 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png ReceiveChar
Attempt to receive a byte from the Zigbee module. 
Fc9-u8-icon.png - BYTE nTimeout
 
Fc9-u8-icon.png - BYTE Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-10-icon.png 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. 
Fc9-type-16-icon.png 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. 
Fc9-type-7-icon.png Auto ID
Automatically generate a PAN ID  
Fc9-type-10-icon.png 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. 
Fc9-type-16-icon.png 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.  
Fc9-type-14-icon.png Max Hops
Specifies the maximum number of retransmits for a Broadcast transmission. 
Fc9-type-16-icon.png 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. 
Fc9-conn-icon.png Connections
Fc9-type-16-icon.png 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. 
Fc9-type-5-icon.png TX
Pin to be used for Transmit data 
Fc9-type-16-icon.png TX Remap Pin
Allows the hardware transmit pin to be configured from a list of available pins based on your target device, 
Fc9-type-5-icon.png RX
Pin to be used for Receive data 
Fc9-type-16-icon.png RX Remap Pin
Allows the hardware receive pin to be configured from a list of available pins based on your target device, 
Fc9-type-16-icon.png Baud Options
Baud rate option selector 
Fc9-type-14-icon.png Baud Rate
 
Fc9-type-16-icon.png 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. 
Fc9-type-5-icon.png 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 
Fc9-type-5-icon.png 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 
Fc9-type-5-icon.png Sleep Pin
Zigbee Sleep Control Pin 
Fc9-conn-icon.png Scan Channels
Fc9-type-7-icon.png 0x0B
Determines if channel will be scanned 
Fc9-type-7-icon.png 0x0C
Determines if channel will be scanned 
Fc9-type-7-icon.png 0x0D
Determines if channel will be scanned 
Fc9-type-7-icon.png 0x0E
Determines if channel will be scanned 
Fc9-type-7-icon.png 0x0F
Determines if channel will be scanned 
Fc9-type-7-icon.png 0x10
Determines if channel will be scanned 
Fc9-type-7-icon.png 0x11
Determines if channel will be scanned 
Fc9-type-7-icon.png 0x12
Determines if channel will be scanned 
Fc9-type-7-icon.png 0x13
Determines if channel will be scanned 
Fc9-type-7-icon.png 0x14
Determines if channel will be scanned 
Fc9-type-7-icon.png 0x15
Determines if channel will be scanned 
Fc9-type-7-icon.png 0x16
Determines if channel will be scanned 
Fc9-type-7-icon.png 0x17
Determines if channel will be scanned 
Fc9-type-7-icon.png 0x18
Determines if channel will be scanned 
Fc9-type-7-icon.png 0x19
Determines if channel will be scanned 
Fc9-type-7-icon.png 0x1A
Determines if channel will be scanned 
Fc9-type-14-icon.png 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. 
Fc9-type-14-icon.png 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. 
Fc9-conn-icon.png Simulation
Fc9-type-10-icon.png Label
 
Fc9-type-7-icon.png 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. 
Fc9-type-7-icon.png Console Data
Selects if the console data is automatically generated or not 
Fc9-type-21-icon.png Console Columns
Number of characters that can be displayed on a single line of the console. 
Fc9-type-16-icon.png 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_(BL0152)_(E-blocks_2)&oldid=32536"