background image

 

 

CLI User Guide 

     

All rights reserved by Allynk Technology Co. Ltd.

 

Rev6 

 

 

 

COORDINATOR / ROUTER

 

User Manual

     

 

 

 

Summary of Contents for CAG-0100

Page 1: ...CLI User Guide All rights reserved by Allynk Technology Co Ltd Rev6 COORDINATOR ROUTER User Manual ...

Page 2: ...6 2 2 Configure Coordinator IP 8 2 3 Configure Daemon Port 12 2 4 Configure Time Zone 13 2 5 Configure NTP Server 14 2 6 Concentrator IP Port 15 2 7 Adjust User Account 16 3 Install Coordinator and Router 19 4 Use Coordinator to do site evaluation 20 4 1 Connect to Coordinator 21 4 2 PAN control 22 4 2 1 Check PAN information 22 4 2 2 Start PAN 23 4 2 3 Stop PAN 25 4 2 4 Awake devices within the P...

Page 3: ...sion Range 30m indoors Connectivity 10 100 Mbps Ethernet Sub 1G wireless Power Supply MicroUSB 5V 1A POE Operating Temperature 10 50 LED Green Blue Red Security Authentication AES128 encryption and dynamic key exchange LED MicroUSB 10 100M Ethernet Ethernet MAC Sub G MAC LED Status Indicator All Off Power off or OS is not running Green On Software is not yet running Blue Blinks Software is running...

Page 4: ... RF error Sub G RF error Disconnect from Concentrator User only sees Green LED on means Coordinator software might encounter some problems 1 2 Router Specifications Model Name CAP 0100 Dimensions 160 160 33 mm Weight 180g Transmission Range 30m indoors Connectivity Sub 1G wireless Power Supply MicroUSB 5V 1A POE Operating Temperature 10 50 LED Green Blue Red Security Authentication AES128 encrypti...

Page 5: ...7205 Green On Router is in Standby state Blue On Router is in Connected state Blue Blinks Router is in JoinNewPan or JoinOtherPan state Red On Software error LED MicroUSB POE as power input source and no data is carried LEDs on RJ45 connector are off all the time Sub G MAC All off 1 4 sec Green On Blue On Connected State Blue On JoinNewPan State JoinOtherPan State Red On SW Error SW Error SW Error...

Page 6: ...rence in a residential installation This equipment generates uses and can radiate radio frequency energy and if not installed and used in accordance with the instructions may cause harmful interference to radio communications However there is no guarantee that interference will not occur in a particular installation If this equipment does cause harmful interference to radio or television reception...

Page 7: ... zip from Github Must have github account first https github com AllynkTechnology coordctl releases latest Unzip coordctl zip to your forder OS supported Linux platform coordctl_cust Windows platform coordctl_cust exe Execute configuration tool Take windows platform for example 1 Run cmd exe 2 Enter the folder you unzip coordctl zip 3 Execute coordctl_cust exe coordctl_cust exe config When you see...

Page 8: ...inator to the same local network area LAN with your PC Ethernet Switch Laptop to run configuration tool Coordinator Coordinator will need microusb to supply power if not using POE switch 2 Read Coordinator s hostname Step2 Coordinator s hostname SMAC Example SMAC C00000000050 Coordinator hostname C00000000050 Step1 Check the sticker on the bottom of Coordinator 3 Execute configuration tool and use...

Page 9: ...Page 8 of 38 8F No 20 Chenggong 13th St Zhubei City Hsinchu County 30264 Taiwan allynk com contact allynk com 886 3 6577205 C00000000050 netlas netlas Username netlas User cannot modify Default Password netlas User can modify 2 2 Configure Coordinator IP 1 Coordinator ip settings ...

Page 10: ...P server is not available DHCP Fallback IP Ethernet Switch with DHCP enabled Ethernet Switch with DHCP disabled IP Dispatched by DHCP server DNS Dispatched by DHCP server Gateway Dispatched by DHCP server IP User configured DNS User configured Gateway User configured Static IP Ethernet Switch with or without DHCP IP User configured DNS User configured Gateway User configured IP Setting Contents IP...

Page 11: ...Manual All rights reserved by Allynk Technology Co Ltd Page 10 of 38 8F No 20 Chenggong 13th St Zhubei City Hsinchu County 30264 Taiwan allynk com contact allynk com 886 3 6577205 3 Modify IP y n DHCP Fallback IP y y Static IP ...

Page 12: ...ights reserved by Allynk Technology Co Ltd Page 11 of 38 8F No 20 Chenggong 13th St Zhubei City Hsinchu County 30264 Taiwan allynk com contact allynk com 886 3 6577205 New IP New Subnet New DNS Gateway Apply new IP settings to coordinator ...

Page 13: ...ggong 13th St Zhubei City Hsinchu County 30264 Taiwan allynk com contact allynk com 886 3 6577205 2 3 Configure Daemon Port 2 Daemon Port Settings Daemon port is the TCP port for program running within Coordinator to communicate with Concentrator program 1 Current Daemon port 2 Modify Daemon Port y New Port ...

Page 14: ...nggong 13th St Zhubei City Hsinchu County 30264 Taiwan allynk com contact allynk com 886 3 6577205 2 4 Configure Time Zone 3 Time Settings TimeZone parameter should follow the format of TZ database name ex Asia Taipei Asia Tokyo America New_York 1 Current time information 2 Modify time zone y New TimeZone ...

Page 15: ...e 14 of 38 8F No 20 Chenggong 13th St Zhubei City Hsinchu County 30264 Taiwan allynk com contact allynk com 886 3 6577205 2 5 Configure NTP Server 4 NTP Settings NTP server help eliminate time drift between coordinator and Concentrator program 1 Current NTP Server 2 Modify NTP server ...

Page 16: ...ubei City Hsinchu County 30264 Taiwan allynk com contact allynk com 886 3 6577205 y New Time server 2 6 Concentrator IP Port 5 Concentrator IP Settings Set Concentrator IP to Coordinator will help user to add coordinator to Concentrator program reversely 1 Current Concentrator IP port settings 2 Modify Concentrator IP port ...

Page 17: ...g 13th St Zhubei City Hsinchu County 30264 Taiwan allynk com contact allynk com 886 3 6577205 y New Concentrator IP New Concentrator Port y 2 7 Adjust User Account 6 User account Settings User list only shows users other than Default user Coordinator cannot be configured once user forgets all accounts password ...

Page 18: ...bei City Hsinchu County 30264 Taiwan allynk com contact allynk com 886 3 6577205 1 Modify current login user s password y Current Password New Password y New Password again 2 Add new account s In addition to default account User can add up to 2 new accounts retype password y y add another n quit y new username new password ...

Page 19: ...Allynk Technology Co Ltd Page 18 of 38 8F No 20 Chenggong 13th St Zhubei City Hsinchu County 30264 Taiwan allynk com contact allynk com 886 3 6577205 3 Delete existing account s Default user cannot be deleted y username to delete y y delete another n quit ...

Page 20: ...8F No 20 Chenggong 13th St Zhubei City Hsinchu County 30264 Taiwan allynk com contact allynk com 886 3 6577205 3 Install Coordinator and Router Screw the attachment on the ceiling Plug in the Ethernet cable Put coordinator or router on the top of attachment and rotate in the clockwise direction ...

Page 21: ...tion Router is ready when Green LED is on Next Router should be added to Sub G network for further usage Please refer to Concentrator documents for more information 4 Use Coordinator to do site evaluation Control you devices via coordctl tool or Concentrator Concentrator control mode in coordctl tool Purpose Full commercial operation Simple operation for environment evaluation Not recommended for ...

Page 22: ... Take windows platform for example 1 Run cmd exe 2 Enter the folder you unzip coordctl zip 3 Execute coordctl_cust exe coordctl_cust exe control When you see the output as the figure below the configuration tool is ready 4 1 Connect to Coordinator For setting up the connection between Coordinator and your PC please refer to section 2 1 Connect to Coordinator Execute configuration tool and use host...

Page 23: ...o 20 Chenggong 13th St Zhubei City Hsinchu County 30264 Taiwan allynk com contact allynk com 886 3 6577205 C00000000050 netlas netlas Username netlas User cannot modify Default Password netlas User can modify 4 2 PAN control PAN is the network controlled by Coordinator 1 4 2 1 Check PAN information ...

Page 24: ...scriptions PanID Unique ID for this PAN Enabled true PAN is on Can be stopped by Stop PAN false PAN is off Can be started by Start PAN Channel The radio frequency this PAN is using Power Transmission power Unit dbm BeaconInterval The frequency of batch processing Awake true PAN is awakening device false PAN is not awakening device 4 2 2 Start PAN Procedures 1 List Channel 2 Scan channel 3 Start pa...

Page 25: ... City Hsinchu County 30264 Taiwan allynk com contact allynk com 886 3 6577205 Channel number Physical radio frequency Scan channel Scan channel can only be executed when PAN enabled false 2 start channel number end channel number Return value true This channel is available Return value Blank This channel is occupied Start pan ...

Page 26: ...allynk com contact allynk com 886 3 6577205 3 channel num tx power Tx Power should be lower than 8 when coordinator is used in Japan Return value true PAN has been started successfully Return value false Error happened during starting PAN 4 2 3 Stop PAN 3 Return value true PAN has been stopped successfully Return value false Error happened during stopping PAN ...

Page 27: ...3th St Zhubei City Hsinchu County 30264 Taiwan allynk com contact allynk com 886 3 6577205 4 2 4 Awake devices within the PAN 4 Start Awakening 1 Awake time Stop Awakening 2 4 2 5 Expel devices from the PAN Before executing this operation user should know the difference between activated and non activated devices ...

Page 28: ...will save PAN s information Yes No Device will search PAN s signal if disconnecting from PAN Yes No PAN needs to execute awake PAN to make device connect No Yes Device will leave this PAN when user executes Purge PAN operation No Yes So Purge Pan is the operation to ask non activated device to leave the PAN 5 The list of purged device s address will be returned when this operation is completed 4 3...

Page 29: ... skipped if user wants to list the same device 2 Field Descriptions C0000200045B Device s extended address END_DEVICE Device type Activated true Activated false Non activated See Activated vs Non activated for more information Time Last operation time Type Last operation type Ex PING Status Last operation status RSSI Received signal strength 30 85 dbm Bigger number represents better signal strengt...

Page 30: ...Delay 360m E Invalid F No Delay 0 Do nothing 1 Lot0 Image 2 Lot1 Image 3 Lot2 Image 4 Lot3 Image 5 Lot4 Image 6 Lot5 Image 7 Lot6 Image 8 Lot7 Image 9 Lot8 Image A Lot9 Image B Invalid C Invalid D Invalid E State F Do nothing 0 No Delay 1 Delay 10m 2 Delay 20m 3 Delay 30m 4 Delay 40m 5 Delay 50m 6 Delay 60m 7 Delay 90m 8 Delay 120m 9 Delay 150m A Delay 180m B Delay 240m C Delay 300m D Delay 360m E...

Page 31: ...Technology Co Ltd Page 30 of 38 8F No 20 Chenggong 13th St Zhubei City Hsinchu County 30264 Taiwan allynk com contact allynk com 886 3 6577205 3 List all devices information Sorted by device s RSSI 4 List all devices information Sorted by device s battery voltage ...

Page 32: ...r Manual All rights reserved by Allynk Technology Co Ltd Page 31 of 38 8F No 20 Chenggong 13th St Zhubei City Hsinchu County 30264 Taiwan allynk com contact allynk com 886 3 6577205 5 4 3 2 Ping device s 2 Ping single device ...

Page 33: ... s extended address END_DEVICE Device type Activated true Activated false Non activated See Activated vs Non activated for more information Time Last operation time Status Last operation status Type Last operation type Ex PING RSSI Received signal strength 30 85 dbm Bigger number represents better signal strength Ex 30 is better than 40 Voltage Battery voltage FirmwareVersion Device s firmware ver...

Page 34: ...com 886 3 6577205 JobId The identifier of previous executed operation ESL will keep the last 4 operations JobStauts The status of previous executed operation ESL will keep the last 4 operations If Status is not STATUS_OK it means ping operation is not completed successfully Ping all devices 3 4 3 3 Send image or command to device 3 Set parameters Target device Device s extended address ...

Page 35: ...30264 Taiwan allynk com contact allynk com 886 3 6577205 1 Device MAC Press Enter to leave without changing current value Target file Image file Please use image file generated by Allynk s tool 2 File Path Header Value Press Enter to leave without changing current value Press Enter to leave without changing current value The usage of image header ...

Page 36: ...splayed with priority when ESL enters JoinNewPan JoinOtherPan or Connected state The related actions defined in UserDefinedBehavior will be ignored Image Data Image Header Sent from Coordinator Byte 1 Operations 0x0 Prioritized save and display Byte 2 Lot 0x2 Lot2 Byte 0 0x0 Fixed value to ESL Received IMG Save to Lot2 In JoinNewPan Connected or JoinOtherPan state In other states Restore to IMG in...

Page 37: ...34 sec inv2 ScanInterval2 ESL short sleep time 0 254 sec iter ScanIteration ESL short sleep rounds 0 254 rounds epd UserDefinedBehavior Control image display when ESL s state changes deactivate Deactivate device imgshow current Refresh current image imgshow index 0 9 Fetch previously stored image Ex imgshow index 1 Fetch image from slot 1 ledon Turn on LED ledoff Turn off LED ledblink on ms off ms...

Page 38: ...tact allynk com 886 3 6577205 OFF ON OFF ON OFF ON 500ms 500ms 500ms 20 seconds Send image 1 Check if target device is correct Modify it if not correct 2 Check if target file is correct Modify it if not correct 3 Send image 4 Send command 1 Check if target device is correct Modify it if not correct 2 Check if target command is correct Modify it if not correct 3 Send command ...

Page 39: ...ynk Technology Co Ltd Page 38 of 38 8F No 20 Chenggong 13th St Zhubei City Hsinchu County 30264 Taiwan allynk com contact allynk com 886 3 6577205 5 4 4 Reconnect Reconnect can check and repair TCP IP connection when it is broken in the middle of operation 3 ...

Reviews: