API Methods
There are 3 groups of calls in the API:
-
Version - Obtain details about the API
-
Discovery - Obtain details about what is connected to the API
-
Connection - Manage connections and devices connected
Version
API Call | Description |
---|---|
cbrx_apiversion | Obtain the version of the API |
cbrx_apidetails | Obtain an enhanced version of the details of the API |
Discovery
API Call | Description |
---|---|
cbrx_discover | Discover Cambrionix units |
cbrx_discover_id_to_os_reference |
Map a unit ID from unit to device as used by the OS |
cbrx_find | Search for devices attached to local Cambrionix units |
cbrx_get_usb (tree) | Return the entire USB tree that has been discovered |
cbrx_get_usb (descriptors) | Request entire dump of a USB device’s descriptor information |
cbrx_config_set | Set configuration options |
Connection
API Call | Description |
---|---|
cbrx_certificate | Manage certificates and private keys to the API |
cbrx_connection_open | Open a connection to a hub |
cbrx_connection_close | Close an open connection to a hub |
cbrx_connection_getdictionary |
Get all keys on a hub specified by the connectionHandle. |
cbrx_connection_get |
Get a key from a hub specified by connectionHandle |
cbrx_hub_get | Get a key from a hub specified by hubs serial number |
cbrx_device_get | Get a key from a hub specified by USB device's serial number |
cbrx_connection_setdictionary | List all writeable and command keys for the hub specified by connectionHandle |
cbrx_connection_set |
Set a key to the value specified on a hub specified by connectionHandle |
cbrx_hub_set |
Set a key to the value specified on a hub specified by hubs serial number |
cbrx_notifications | Send notifications |
cbrx_firmware | Add or remove firmware files |
cbrx_connection_closeandlock | Close all connections to a hub and lock it |
cbrx_connection_unlock | Unlock a hub that was previously locked. |
cbrx_connection_cli | Perform command line interface operation |
cbrx_pair_device | Initiaite pairing of an iOS device |
cbrx_exit | Restart the API |