Difference between revisions of "Cradlepoint"

From HSYCO
Jump to navigation Jump to search
(Created page with "The Cradlepoint driver for HSYCO allows you to monitor the real-time status of the Cradlepoint IBR6xx series of routers. The driver can send most of the remote control comman...")
 
 
(14 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
The Cradlepoint driver for HSYCO allows you to monitor the real-time status of the Cradlepoint IBR6xx series of routers.
 
The Cradlepoint driver for HSYCO allows you to monitor the real-time status of the Cradlepoint IBR6xx series of routers.
  
−
The driver can send most of the remote control commands, and a few extra commands not present on the remote, but can’t turn on a TV. The driver is basically one-way, it sends commands but doesn’t have any information of the current state of the TV, it only knows if the TV is on and can accept commands from HSYCO.
+
[[File:IO_Servers_Cradlepoint.png]]
−
 
 
−
When you initially configure the Smart TV I/O server in HSYCO and the server restarts, you should have your TV on. The TV will then show a message asking to accept connections from HSYCO.
 
−
 
 
−
{{note|We can’t provide a list of Samsung Smart TV models that work with this driver. In general, most recent models from 2012 on should work. We do not guarantee that this driver will work with any specific model and firmware version.}}
 
  
 
[[Category:I/O Server]]
 
[[Category:I/O Server]]
  
 
== HSYCO Configuration ==
 
== HSYCO Configuration ==
−
Add a SAMSUNGTV I/O Server in the [[Settings#I/O Servers|I/O Servers section of the Settings]] and set its parameters:
+
Add a CRADLEPOINT I/O Server in the [[Settings#I/O Servers|I/O Servers section of the Settings]] and set its parameters:
  
 
=== Communication ===
 
=== Communication ===
−
*'''IP Address''': IP address of the TV
+
*'''IP Address''': LAN IP address of the IBR6xx router
−
*'''IP Port''': TCP/IP port to use, leave blank to use default port 55000.
+
*'''IP Port''': TCP/IP port to use for the SSH CLI (Command Line Interface), leave blank to use default port 22.
  
 
=== High Availability ===
 
=== High Availability ===
 
*'''Shutdown when inactive''': defaults to false.
 
*'''Shutdown when inactive''': defaults to false.
  
−
== Datapoints ==
+
=== Options ===
  
 
{| class="wikitable"
 
{| class="wikitable"
 
!ID
 
!ID
−
!Value
+
!Default
−
!R/W
+
!Values
 
!Description
 
!Description
 
|-
 
|-
  
−
|send
+
|rowspan="2"|startupevents
−
|<command_code>
+
|rowspan="2"|false
−
|W
+
|true
−
|send the specified control command (see table below)
+
|generate IO events also during the driver’s start-up phase
 +
|-
 +
|false
 +
|start generating events only after HSYCO is aligned with the current status of the system
 +
|-
 +
 
 +
|query
 +
|/status/wan/connection_state /status/system/wan_signal_strength /status/wan/stats
 +
|space-separated pathnames
 +
|this parameter can be used to retrieve specific status data from the router. Use / to retrieve all data (note that using / the router will need several seconds to return all data, and the number of generated data points will be huge. You should specify the / full path only for development purposes
 
|-
 
|-
 +
 
|}
 
|}
  
−
Most Samsung Smart TV models should accept the following command codes. Other undocumented commands may also be supported.
+
== Datapoints ==
 +
 
 +
The status information that the driver retrieves from the Cradlepoint router depends on the pathnames defined in the query option.
 +
 
 +
Refer to the CRADLEPOINT Router CLI Overview document for the description of the file system structure and the list of valid directories.
 +
Each directory contains status information that this driver translates into standard HSYCO data points.
 +
 
 +
When no query option is explicitly set, the driver retrieves all data located in the following directories:
 +
* /status/wan/connection_state
 +
* /status/system/wan_signal_strength
 +
* /status/wan/stats
 +
 
 +
 
 +
{{note|The following table lists the read-only data poins that are generated using the default query.}}
 +
 
  
 
{| class="wikitable"
 
{| class="wikitable"
−
!Command code
+
!ID
 +
!Value
 +
!R/W
 
!Description
 
!Description
 
|-
 
|-
  
−
|0
+
|rowspan="2" |connection
−
|0
+
|online
 +
|R
 +
|connection established
 
|-
 
|-
−
|1
+
|offline
−
|1
+
|R
 +
|HSYCO can't connect to the router
 
|-
 
|-
−
|2
+
 
−
|2
+
|status.system.wan_signal_strength
 +
|0..100
 +
|R
 +
|wireless WAN connection signal strength
 
|-
 
|-
−
|3
+
 
−
|3
+
|status.wan.connection_state
 +
|<status>
 +
|R
 +
|WAN connection status
 
|-
 
|-
−
|4
+
 
−
|4
+
|status.wan.stats.bps
 +
|<number>
 +
|R
 +
|WAN total throughput in BPS
 
|-
 
|-
−
|5
+
 
−
|5
+
|status.wan.stats.collisions
 +
|<number>
 +
|R
 +
|number of collisions on the WAN connection
 
|-
 
|-
−
|6
+
 
−
|6
+
|status.wan.stats.ibps
 +
|<number>
 +
|R
 +
|WAN input throughput in BPS
 
|-
 
|-
−
|7
+
 
−
|7
+
|status.wan.stats.idrops
 +
|<number>
 +
|R
 +
|wireless WAN input packets dropped
 
|-
 
|-
−
|8
+
 
−
|8
+
|status.wan.stats.ierrors
 +
|<number>
 +
|R
 +
|wireless WAN input errors
 
|-
 
|-
−
|9
+
 
−
|9
+
|status.wan.stats.imcasts
 +
|<number>
 +
|R
 +
|wireless WAN input multicast traffic
 
|-
 
|-
−
|UP
+
 
−
|up
+
|status.wan.stats.in
 +
|<number>
 +
|R
 +
|wireless WAN total input bytes of current connection
 
|-
 
|-
−
|DOWN
+
 
−
|down
+
|status.wan.stats.ipackets
 +
|<number>
 +
|R
 +
|wireless WAN total input packets of current connection
 
|-
 
|-
−
|LEFT
+
 
−
|left
+
|status.wan.stats.noproto
 +
|<number>
 +
|R
 +
|wireless WAN total no protocol packets
 
|-
 
|-
−
|RIGHT
+
 
−
|right
+
|status.wan.stats.obps
 +
|<number>
 +
|R
 +
|WAN output throughput in BPS
 
|-
 
|-
−
|ENTER
+
 
−
|enter
+
|status.wan.stats.oerrors
 +
|<number>
 +
|R
 +
|wireless WAN output errors
 
|-
 
|-
−
|INFO
+
 
−
|info
+
|status.wan.stats.omcasts
 +
|<number>
 +
|R
 +
|wireless WAN output multicast traffic
 
|-
 
|-
−
|EXIT
+
 
−
|exit
+
|status.wan.stats.opackets
 +
|<number>
 +
|R
 +
|wireless WAN total output packets of current connection
 
|-
 
|-
−
|RETURN
+
 
−
|return
+
|status.wan.stats.out
 +
|<number>
 +
|R
 +
|wireless WAN total output bytes of current connection
 
|-
 
|-
−
|MENU
+
 
−
|menu
+
|status.wan.stats.ts
 +
|<number>
 +
|R
 +
|wireless WAN current connection time in seconds (ignore the decimal part)
 
|-
 
|-
−
|TOOLS
+
 
−
|tools
+
|command
 +
|<command>
 +
|W
 +
|send a generic CLI command to the router. The <command> value is a text string exactly as specified in the CLI documentation
 
|-
 
|-
−
|SOURCE
+
 
−
|source
+
|router
−
|-
+
|reboot
−
|VOLUP
+
|W
−
|increase volume
+
|reboot the router
−
|-
 
−
|VOLDOWN
 
−
|decrease volume
 
−
|-
 
−
|MUTE
 
−
|mute
 
−
|-
 
−
|CHUP
 
−
|next channel
 
−
|-
 
−
|CHDOWN
 
−
|previous channel
 
−
|-
 
−
|TV
 
−
|select the internal TV tuner source
 
−
|-
 
−
|HDMI
 
−
|select one of the HDMI sources (depends on the TV model)
 
−
|-
 
−
|POWEROFF
 
−
|turn TV off (can’t turn it back on)
 
−
|-
 
−
|PIP_ONOFF
 
−
|picture-in-picture on/off
 
−
|-
 
−
|PIP_CHDOWN
 
−
|next channel in PIP window
 
−
|-
 
−
|PIP_CHUP
 
−
|previous channel in PIP window
 
−
|-
 
−
|PIP_SWAP
 
−
|swaps PIP and main screen sources
 
 
|-
 
|-
 
|}
 
|}
  
−
== User Interface ==
+
== Release Notes ==
 +
=== 3.7.0 ===
 +
*fixed error parsing data points returning long values
  
−
You can easily associate any user button to a specific command to be sent to the TV. Set ''name'' to the I/O Server name and ''param'' to the command code.
+
=== 3.5.0 ===
 +
*performance improvements
  
−
[[File:IO Server SamsungTV Interface.png]]
+
=== 3.4.0 ===
−
 
+
*initial release
−
You can also enable the Repeat mode, so that multiple commands will be sent to the TV while the button is pressed.
 
−
 
 
−
== Release Notes ==
 
−
=== 3.3.0 ===
 
−
*initial release version
 
  
 
----
 
----
  
  
−
''Samsung and Samsung Smart TV are either trademarks or registered trademarks of Samsung Electronics Co., Ltd.''
+
''Cradlepoint is a registered trademark of CradlePoint Technology, Inc.

Latest revision as of 17:11, 2 April 2020

The Cradlepoint driver for HSYCO allows you to monitor the real-time status of the Cradlepoint IBR6xx series of routers.

IO Servers Cradlepoint.png

HSYCO Configuration

Add a CRADLEPOINT I/O Server in the I/O Servers section of the Settings and set its parameters:

Communication

  • IP Address: LAN IP address of the IBR6xx router
  • IP Port: TCP/IP port to use for the SSH CLI (Command Line Interface), leave blank to use default port 22.

High Availability

  • Shutdown when inactive: defaults to false.

Options

ID Default Values Description
startupevents false true generate IO events also during the driver’s start-up phase
false start generating events only after HSYCO is aligned with the current status of the system
query /status/wan/connection_state /status/system/wan_signal_strength /status/wan/stats space-separated pathnames this parameter can be used to retrieve specific status data from the router. Use / to retrieve all data (note that using / the router will need several seconds to return all data, and the number of generated data points will be huge. You should specify the / full path only for development purposes

Datapoints

The status information that the driver retrieves from the Cradlepoint router depends on the pathnames defined in the query option.

Refer to the CRADLEPOINT Router CLI Overview document for the description of the file system structure and the list of valid directories. Each directory contains status information that this driver translates into standard HSYCO data points.

When no query option is explicitly set, the driver retrieves all data located in the following directories:

  • /status/wan/connection_state
  • /status/system/wan_signal_strength
  • /status/wan/stats


The following table lists the read-only data poins that are generated using the default query.


ID Value R/W Description
connection online R connection established
offline R HSYCO can't connect to the router
status.system.wan_signal_strength 0..100 R wireless WAN connection signal strength
status.wan.connection_state <status> R WAN connection status
status.wan.stats.bps <number> R WAN total throughput in BPS
status.wan.stats.collisions <number> R number of collisions on the WAN connection
status.wan.stats.ibps <number> R WAN input throughput in BPS
status.wan.stats.idrops <number> R wireless WAN input packets dropped
status.wan.stats.ierrors <number> R wireless WAN input errors
status.wan.stats.imcasts <number> R wireless WAN input multicast traffic
status.wan.stats.in <number> R wireless WAN total input bytes of current connection
status.wan.stats.ipackets <number> R wireless WAN total input packets of current connection
status.wan.stats.noproto <number> R wireless WAN total no protocol packets
status.wan.stats.obps <number> R WAN output throughput in BPS
status.wan.stats.oerrors <number> R wireless WAN output errors
status.wan.stats.omcasts <number> R wireless WAN output multicast traffic
status.wan.stats.opackets <number> R wireless WAN total output packets of current connection
status.wan.stats.out <number> R wireless WAN total output bytes of current connection
status.wan.stats.ts <number> R wireless WAN current connection time in seconds (ignore the decimal part)
command <command> W send a generic CLI command to the router. The <command> value is a text string exactly as specified in the CLI documentation
router reboot W reboot the router

Release Notes

3.7.0

  • fixed error parsing data points returning long values

3.5.0

  • performance improvements

3.4.0

  • initial release


Cradlepoint is a registered trademark of CradlePoint Technology, Inc.

Retrieved from "https://wiki.hsyco.com/3.8/index.php?title=Cradlepoint&oldid=8631"