UserConfig Endpoint

Interface for saving individual entity instances to non-volatile storage.

GET /api/v1/brainstem/(serial_num)/userconfig/(index)/saveentitytostore/(command)/(index)

Saves the given entity to the Store

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.

  • command – Protocol Definition for Entity Command (i.e. value of cmdSOMETHING)

  • index – Index of Entity to access

GET /api/v1/brainstem/(serial_num)/userconfig/(index)/resetentitytofactorydefaults/(command)/(index)

Resets the given entity to factory defaults

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.

  • command – Protocol Definition for Entity Command (i.e. value of cmdSOMETHING)

  • index – Index of Entity to access

GET /api/v1/brainstem/(serial_num)/userconfig/(index)/loadentityfromstore/(command)/(index)

Restores the saved configuration of the given entity

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.

  • command – Protocol Definition for Entity Command (i.e. value of cmdSOMETHING)

  • index – Index of Entity to access