Icron USB Extender (legacy)

Deprecated node

The USB_ICRON node described on this page is legacy. The SDVoE Control Server has renamed and restructured it into the chipset-agnostic USB_EXTENDER node. Modern Control Server builds emit both nodes in the same get device response so existing integrations keep working during the transition.

New integrations should target USB_EXTENDER.

Existing integrations migrating away from USB_ICRON should read the USB Extender Node Rename Migration Guide for the full field-by-field mapping and a recommended dual-shape accessor pattern.

A Node object whose type is USB_ICRON.

Configuration

UsbIcronChipNodeConfig
{
    "extender_type" : String,
    "program_mode" : String,
    "rs232_port" : Integer
}

Member name	Type	Description
extender_type	String	The type of extender: LOCAL for a local extender (LEX). REMOTE for a remote extender (REX).
program_mode	String	Currently enabled programming mode for the USB extender. Will be one of the following: FIRMWARE for the extender's firmware. EEPROM for the extender's non-volatile configuration memory. NONE if programming is disabled. Note: This programming mode is set using Icron program command.
rs232_port	Integer	The (zero-based) number of the RS-232 port through which programming of the USB extender is enabled. If value of the program_mode member is NONE, this value is undefined.

Status

UsbIcronChipNodeStatus
{
    "chip_present": Boolean,
    "mac_address": String,
    "reachable": Boolean,
    "revision": String,
    "ip_mode": String,
    "ip_address": String,
    "peer_mac_address": String,
    "peer_device_id": String,
    "link_status_support": Boolean,
    "linked": Boolean
}

Member name	Type	Description
chip_present	Boolean	Whether an Icron module is detected. false if Icron USB is enabled in the hardware configuration but the module has not been populated.
mac_address	String	MAC address of the Icron module. Blank ("") if the module has not been detected.
reachable	Boolean	Whether the USB extender network interface is reachable with an IP address.
revision	String	The revision level of the Icron firmware.
ip_mode	String	The active IP mode, either DHCP or manual (static).
ip_address	String	The current IP address of the extender interface.
peer_mac_address	String	If paired, the MAC address of the peer extender. Blank ("") if the extender is not paired or no module has been detected.
peer_device_id	String	If paired, the device id of the BlueRiver device associated with the peer Icron device. Blank ("") if the extender is not paired or no module has been detected.
link_status_support	Boolean	Whether the Icron supports the linked attribute.
linked	Boolean	Whether bidirectional communication is currently established. false when the devices are not paired, when link negotiation has not succeeded, or when link_status_support is false.

Inputs

None

Example

As returned by get device:

REX
{
  "type": "USB_ICRON",
  "index": 0,
  "configuration": {
    "extender_type": "REMOTE",
    "program_mode": "NONE",
    "rs232_port": 0
  },
  "status": {
    "chip_present": true,
    "mac_address": "0016c035571d",
    "reachable": true,
    "revision": "1.9.4",
    "ip_mode": "DHCP",
    "ip_address": "192.168.100.22",
    "peer_mac_address": "0016c035566f",
    "peer_device_id": "d8803962e132",
    "link_status_support": true,
    "linked": true
  },
  "inputs": []
}

LEX, on device d8803962e132
{
  "type": "USB_ICRON",
  "index": 0,
  "configuration": {
    "extender_type": "LOCAL",
    "program_mode": "NONE",
    "rs232_port": 0
  },
  "status": {
    "chip_present": true,
    "mac_address": "0016c035566f",
    "reachable": true,
    "revision": "1.9.4",
    "ip_mode": "DHCP",
    "ip_address": "192.168.100.20",
    "peer_mac_address": "0016c035571d",
    "peer_device_id": "0016c035566e",
    "link_status_support": true,
    "linked": true
  },
  "inputs": []
}