App Endpoint

Used to send a cmdAPP packet to the BrainStem network.

These commands are used for either host-to-stem or stem-to-stem interactions.

BrainStem modules can implement a reflex origin to complete an action when a cmdAPP packet is addressed to the module.

See the App Entity for generic information.

PUT /api/v1/brainstem/(serial_num)/app/(index)/execute

Execute the app reflex on the module.

Doesn’t wait for a return value from the execute call; this call returns immediately upon execution of the module’s reflex.

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