USBSystem Endpoint

The USBSystem class provides high level control of the lower level Port Class.

See the USBSystem Entity for generic information.

GET /api/v1/brainstem/(serial_num)/usbsystem/(index)/upstreamport

Gets the upstream port.

See JSON Schema for Response Object

Parameters:

• serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

• index – Index of entity to access. Default is 0.

Response JSON Object:

• response.value (integer) – Value formatted as an integer

• response.rawValue (integer) – Unformatted value

PUT /api/v1/brainstem/(serial_num)/usbsystem/(index)/upstreamport

Sets the upstream port.

See JSON Schema for Request Object and Response Object

Parameters:

• serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

• index – Index of entity to access. Default is 0.

Request JSON Object:

• value (integer) –

  8-bit Integer value to set.

  May be specified as an integer or a string (formatted as “123”, “0x12”, etc.)

Response JSON Object:

• response.value (integer) – Value formatted as an integer

• response.rawValue (integer) – Unformatted value

GET /api/v1/brainstem/(serial_num)/usbsystem/(index)/enumerationdelay

Gets the inter-port enumeration delay in milliseconds.

Delay is applied upon hub enumeration.

See JSON Schema for Response Object

Parameters:

• serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

• index – Index of entity to access. Default is 0.

Response JSON Object:

• response.value (integer) – Value formatted as an integer

• response.rawValue (integer) – Unformatted value

PUT /api/v1/brainstem/(serial_num)/usbsystem/(index)/enumerationdelay

Sets the inter-port enumeration delay in milliseconds.

Delay is applied upon hub enumeration.

See JSON Schema for Request Object and Response Object

Parameters:

• serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

• index – Index of entity to access. Default is 0.

Request JSON Object:

• value (integer) –

  32-bit Integer value to set.

  May be specified as an integer or a string (formatted as “123”, “0x12”, etc.)

Response JSON Object:

• response.value (integer) – Value formatted as an integer

• response.rawValue (integer) – Unformatted value

GET /api/v1/brainstem/(serial_num)/usbsystem/(index)/datarolelist

Gets the data role of all ports with a single call

Equivalent to calling PortClass::getDataRole() on each individual port.

See JSON Schema for Response Object

Parameters:

• serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

• index – Index of entity to access. Default is 0.

Response JSON Object:

• response.value (integer) – Value formatted as an integer

• response.rawValue (integer) – Unformatted value

GET /api/v1/brainstem/(serial_num)/usbsystem/(index)/enabledlist

Gets the current enabled status of all ports with a single call.

Equivalent to calling PortClass::setEnabled() on each port.

See JSON Schema for Response Object

Parameters:

• serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

• index – Index of entity to access. Default is 0.

Response JSON Object:

• response.value (integer) – Value formatted as an integer

• response.rawValue (integer) – Unformatted value

PUT /api/v1/brainstem/(serial_num)/usbsystem/(index)/enabledlist

Sets the enabled status of all ports with a single call.

Equivalent to calling PortClass::setEnabled() on each port.

See JSON Schema for Request Object and Response Object

Parameters:

• serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

• index – Index of entity to access. Default is 0.

Request JSON Object:

• value (integer) –

  32-bit Integer value to set.

  May be specified as an integer or a string (formatted as “123”, “0x12”, etc.)

Response JSON Object:

• response.value (integer) – Value formatted as an integer

• response.rawValue (integer) – Unformatted value

GET /api/v1/brainstem/(serial_num)/usbsystem/(index)/modelist

Gets the current mode of all ports with a single call.

Equivalent to calling PortClass:getMode() on each port.

See JSON Schema for Response Object

Parameters:

• serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

• index – Index of entity to access. Default is 0.

Response JSON Object:

• response.value (string) – Value formatted as a list of integers

• response.rawValue (list(integer)) – Unformatted value

PUT /api/v1/brainstem/(serial_num)/usbsystem/(index)/modelist

Sets the mode of all ports with a single call.

Equivalent to calling PortClass::setMode() on each port

See JSON Schema for Request Object and Response Object

Parameters:

• serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

• index – Index of entity to access. Default is 0.

Request JSON Object:

• value (list) –

  List of 32-bit values to set.

  May be specified as: * List of integers * List of strings (formatted as “0x40”, “40”, etc.)

Response JSON Object:

• response.value (string) – Value formatted as a list of integers

• response.rawValue (list(integer)) – Unformatted value

GET /api/v1/brainstem/(serial_num)/usbsystem/(index)/statelist

Gets the state for all ports with a single call.

Equivalent to calling PortClass::getState() on each port.

See JSON Schema for Response Object

Parameters:

• serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

• index – Index of entity to access. Default is 0.

Response JSON Object:

• response.value (string) – Value formatted as a list of integers

• response.rawValue (list(integer)) – Unformatted value

GET /api/v1/brainstem/(serial_num)/usbsystem/(index)/powerbehavior

Gets the behavior of the power manager.

The power manager is responsible for budgeting the power of the system, i.e. What happens when requested power greater than available power.

See JSON Schema for Response Object

Parameters:

• serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

• index – Index of entity to access. Default is 0.

Response JSON Object:

• response.value (integer) – Value formatted as an integer

• response.rawValue (integer) – Unformatted value

PUT /api/v1/brainstem/(serial_num)/usbsystem/(index)/powerbehavior

Sets the behavior of how available power is managed, i.e. What happens when requested power is greater than available power.

See JSON Schema for Request Object and Response Object

Parameters:

• serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

• index – Index of entity to access. Default is 0.

Request JSON Object:

• value (integer) –

  8-bit Integer value to set.

  May be specified as an integer or a string (formatted as “123”, “0x12”, etc.)

Response JSON Object:

• response.value (integer) – Value formatted as an integer

• response.rawValue (integer) – Unformatted value

GET /api/v1/brainstem/(serial_num)/usbsystem/(index)/powerbehaviorconfig

Gets the current power behavior configuration.

Certain power behaviors use a list of ports to determine priority when budgeting power.

See JSON Schema for Response Object

Parameters:

• serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

• index – Index of entity to access. Default is 0.

Response JSON Object:

• response.value (string) – Value formatted as a list of integers

• response.rawValue (list(integer)) – Unformatted value

PUT /api/v1/brainstem/(serial_num)/usbsystem/(index)/powerbehaviorconfig

Sets the current power behavior configuration.

Certain power behaviors use a list of ports to determine priority when budgeting power.

See JSON Schema for Request Object and Response Object

Parameters:

• serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

• index – Index of entity to access. Default is 0.

Request JSON Object:

• value (list) –

  List of 32-bit values to set.

  May be specified as: * List of integers * List of strings (formatted as “0x40”, “40”, etc.)

Response JSON Object:

• response.value (string) – Value formatted as a list of integers

• response.rawValue (list(integer)) – Unformatted value

GET /api/v1/brainstem/(serial_num)/usbsystem/(index)/databehavior

Gets the behavior of how upstream and downstream ports are determined, i.e. How do you manage requests for data role swaps and new upstream connections.

See JSON Schema for Response Object

Parameters:

• serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

• index – Index of entity to access. Default is 0.

Response JSON Object:

• response.value (integer) – Value formatted as an integer

• response.rawValue (integer) – Unformatted value

PUT /api/v1/brainstem/(serial_num)/usbsystem/(index)/databehavior

Sets the behavior of how upstream and downstream ports are determined, i.e. How do you manage requests for data role swaps and new upstream connections.

See JSON Schema for Request Object and Response Object

Parameters:

• serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

• index – Index of entity to access. Default is 0.

Request JSON Object:

• value (integer) –

  8-bit Integer value to set.

  May be specified as an integer or a string (formatted as “123”, “0x12”, etc.)

Response JSON Object:

• response.value (integer) – Value formatted as an integer

• response.rawValue (integer) – Unformatted value

GET /api/v1/brainstem/(serial_num)/usbsystem/(index)/databehaviorconfig

Gets the current data role behavior configuration.

Certain data role behaviors use a list of ports to determine priority host priority.

See JSON Schema for Response Object

Parameters:

• serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

• index – Index of entity to access. Default is 0.

Response JSON Object:

• response.value (string) – Value formatted as a list of integers

• response.rawValue (list(integer)) – Unformatted value

PUT /api/v1/brainstem/(serial_num)/usbsystem/(index)/databehaviorconfig

Sets the current data role behavior configuration.

Certain data role behaviors use a list of ports to determine host priority.

See JSON Schema for Request Object and Response Object

Parameters:

• serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

• index – Index of entity to access. Default is 0.

Request JSON Object:

• value (list) –

  List of 32-bit values to set.

  May be specified as: * List of integers * List of strings (formatted as “0x40”, “40”, etc.)

Response JSON Object:

• response.value (string) – Value formatted as a list of integers

• response.rawValue (list(integer)) – Unformatted value

GET /api/v1/brainstem/(serial_num)/usbsystem/(index)/selectormode

Gets the current mode of the selector input.

This mode determines what happens and in what order when the external selector input is used.

See JSON Schema for Response Object

Parameters:

• serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

• index – Index of entity to access. Default is 0.

Response JSON Object:

• response.value (integer) – Value formatted as an integer

• response.rawValue (integer) – Unformatted value

PUT /api/v1/brainstem/(serial_num)/usbsystem/(index)/selectormode

Sets the current mode of the selector input.

This mode determines what happens and in what order when the external selector input is used.

See JSON Schema for Request Object and Response Object

Parameters:

• serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

• index – Index of entity to access. Default is 0.

Request JSON Object:

• value (integer) –

  8-bit Integer value to set.

  May be specified as an integer or a string (formatted as “123”, “0x12”, etc.)

Response JSON Object:

• response.value (integer) – Value formatted as an integer

• response.rawValue (integer) – Unformatted value

GET /api/v1/brainstem/(serial_num)/usbsystem/(index)/upstreamhsport

Gets the USB HighSpeed upstream port.

See JSON Schema for Response Object

Parameters:

• serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

• index – Index of entity to access. Default is 0.

Response JSON Object:

• response.value (integer) – Value formatted as an integer

• response.rawValue (integer) – Unformatted value

PUT /api/v1/brainstem/(serial_num)/usbsystem/(index)/upstreamhsport

Sets the USB HighSpeed upstream port.

See JSON Schema for Request Object and Response Object

Parameters:

• serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

• index – Index of entity to access. Default is 0.

Request JSON Object:

• value (integer) –

  8-bit Integer value to set.

  May be specified as an integer or a string (formatted as “123”, “0x12”, etc.)

Response JSON Object:

• response.value (integer) – Value formatted as an integer

• response.rawValue (integer) – Unformatted value

GET /api/v1/brainstem/(serial_num)/usbsystem/(index)/upstreamssport

Gets the USB SuperSpeed upstream port.

See JSON Schema for Response Object

Parameters:

• serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

• index – Index of entity to access. Default is 0.

Response JSON Object:

• response.value (integer) – Value formatted as an integer

• response.rawValue (integer) – Unformatted value

PUT /api/v1/brainstem/(serial_num)/usbsystem/(index)/upstreamssport

Sets the USB SuperSpeed upstream port.

See JSON Schema for Request Object and Response Object

Parameters:

• serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

• index – Index of entity to access. Default is 0.

Request JSON Object:

• value (integer) –

  8-bit Integer value to set.

  May be specified as an integer or a string (formatted as “123”, “0x12”, etc.)

Response JSON Object:

• response.value (integer) – Value formatted as an integer

• response.rawValue (integer) – Unformatted value

GET /api/v1/brainstem/(serial_num)/usbsystem/(index)/override

Gets the current enabled overrides

See JSON Schema for Response Object

Parameters:

• serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

• index – Index of entity to access. Default is 0.

Response JSON Object:

• response.value (integer) – Value formatted as an integer

• response.rawValue (integer) – Unformatted value

PUT /api/v1/brainstem/(serial_num)/usbsystem/(index)/override

Sets the current enabled overrides

See JSON Schema for Request Object and Response Object

Parameters:

• serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

• index – Index of entity to access. Default is 0.

Request JSON Object:

• value (integer) –

  32-bit Integer value to set.

  May be specified as an integer or a string (formatted as “123”, “0x12”, etc.)

Response JSON Object:

• response.value (integer) – Value formatted as an integer

• response.rawValue (integer) – Unformatted value

PUT /api/v1/brainstem/(serial_num)/usbsystem/(index)/datahsmaxdatarate

Sets the USB HighSpeed Max datarate

See JSON Schema for Request Object and Response Object

Parameters:

• serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

• index – Index of entity to access. Default is 0.

Request JSON Object:

• value (integer) –

  32-bit Integer value to set.

  May be specified as an integer or a string (formatted as “123”, “0x12”, etc.)

Response JSON Object:

• response.value (integer) – Value formatted as an integer

• response.rawValue (integer) – Unformatted value

GET /api/v1/brainstem/(serial_num)/usbsystem/(index)/datahsmaxdatarate

Gets the USB HighSpeed Max datarate

See JSON Schema for Response Object

Parameters:

• serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

• index – Index of entity to access. Default is 0.

Response JSON Object:

• response.value (integer) – Value formatted as an integer

• response.rawValue (integer) – Unformatted value

PUT /api/v1/brainstem/(serial_num)/usbsystem/(index)/datassmaxdatarate

Sets the USB SuperSpeed Max datarate

See JSON Schema for Request Object and Response Object

Parameters:

• serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

• index – Index of entity to access. Default is 0.

Request JSON Object:

• value (integer) –

  32-bit Integer value to set.

  May be specified as an integer or a string (formatted as “123”, “0x12”, etc.)

Response JSON Object:

• response.value (integer) – Value formatted as an integer

• response.rawValue (integer) – Unformatted value

GET /api/v1/brainstem/(serial_num)/usbsystem/(index)/datassmaxdatarate

Gets the USB SuperSpeed Max datarate

See JSON Schema for Response Object

Parameters:

• serial_num – Serial Number of device to access. Formatted as a hex string (e.g. “0x1234ABCD’). Optional on embedded REST server.

• index – Index of entity to access. Default is 0.

Response JSON Object:

• response.value (integer) – Value formatted as an integer

• response.rawValue (integer) – Unformatted value