1450 E Highwood Blvd Pontiac, MI 483x40

v0.1 (1/2/2022)


Endpoints

1. /v1/

  1. /v1/chart/<signal_description>

  2. /v1/charts/<signal_descriptions>

  3. /v1/command/<function_description>

  4. /v1/commands/

  5. /v1/diagnostics/controllers/

  6. /v1/diagnostics/controllers/<controller_tla>/

  7. /v1/diagnostics/controllers/<controller_tla>/<parameter_name>

  8. /v1/diagnostics/controllers/<controller_tla>/<parameter_name>/<signal_name>

  9. /v1/frames/<filter_id>

  10. /v1/frames/<filter_id>/<prop>

  11. /v1/gauge/<signal_description>

  12. /v1/gauges/<signal_description_list>

  13. /v1/gauges/<signal_description_list>

  14. /v1/help/commands/

  15. /v1/help/services/

  16. /v1/help/signals

  17. /v1/history/signal/<signal_description>

  18. /v1/service/<service_description>

  19. /v1/service/<service_description>

  20. /v1/services/

  21. /v1/signal/<signal>

  22. /v1/signal/<signal>/<prop>

  23. /v1/signals/

  24. /v1/signals/<filter_text>

  25. /v1/signals/<filter_text>/<signal_attribute>

  26. /v1/stream/stream-data/<chart_signal>

  27. /v1/stream/stream-data/<chart_signal>/<float:delay>

  28. /v1/streams/stream-data/<signal_descriptions>

  29. /v1/streams/stream-data/<signal_descriptions>/<float:delay>

  30. /v1/tables/<signal_description_list>


Details

/v1/

Methods:

GET, POST


Inputs:

None


Return:

JSON: List of ‘v1’ apis


Error:

None


/v1/chart/<signal_description>

Methods:

GET, POST


Inputs:

signal_description: Name of signal requested


Arguments:

delay: Float, loop delay for sending signal updates

width: Int, points to display


Return:

HTML: Google Chart of requested signal


Error:

None


/v1/charts/<signal_descriptions>

Methods:

GET, POST


Inputs:

signal_descriptions: Comma separated list of signals requested


Arguments:

delay: Float, loop delay for sending signal updates

width: Int, points to display


Return:

HTML: Google Chart of requested signals


Error:

None


/v1/commands/

Methods:

GET, POST


Inputs:

None


Return:

JSON: List of commands supported by endpoint


Error:

None


/v1/command/<function_description>

/v1/help/commands/

Methods:

GET, POST


Inputs:

function_description: Command (Function) description requested to be performed


Return:

JSON: status of request


Error:

None


/v1/diagnostics/controllers/

Methods:

GET, POST


Inputs:

None


Return:

JSON: List of diagnostic controllers Three Letter Anagrams (tlas)


Error:

None


/v1/diagnostics/controllers/<controller_tla>

Methods:

GET, POST


Inputs:

controller_tla: Three letter anagram of controller


Return:

JSON: List of diagnostic parameters available for controller


Error:

None


/v1/help/signals

Methods:

GET, POST


Inputs:

None


Return:

JSON: List of properties (prop) available for signals


Error:

None


/v1/history/signal/<signal_description>

Methods:

GET, POST


Inputs:

signal_description: Description of requested signal’s history


Arguments:

count: Int, number of entries to return

timestamp: Float, Unix timestamp of the last entry to return seconds: Float, time, in seconds, of duration of entries to return Value_type: Encoded, Return ‘value’ or ‘enumerated_value’ of signal

Return:

JSON: List of properties (prop) available for signals


Error:

JSON: Incorrect signal_descritpion


/v1/services/

Methods:

GET, POST


Inputs:

None


Return:

JSON: List of services supported


Error:

None


/v1/service/<service_description>

Methods:

GET


Inputs:

service_description: Service name to be activated


Return:

JSON: List of services supported


Error:

None


/v1/service/<service_description>

Methods:

POST


Inputs:

service_description: Service name query


Return:

JSON: Status of Service (active or inactive)


Error:

None


/v1/signals/<filter_text>

Methods:

GET, POST


Inputs:

filter_text: Regex of signal description


Arguments:

ignore_null: Boolean, filter null values from response

gt: Float, only respond with values greater than given value

lt: Float, only respond with values less than given value


Return:

JSON: List of signal values that match the regular expression and optional arguments


Error:

None


/v1/signals/<filter_text>/<signal_attribute>

Methods:

GET, POST


Inputs:

filter_text: Regex of signal description

signal_attribute: signal property to display


Return:

JSON: List of signals’ of selected property that match the regular expression


Error:

None


/v1/diagnostics/controllers/<controller_tla>/<parameter_name>

Methods:

GET, POST


Inputs:

controller_tla: Three letter anagram of controller

parameter_name: Requested parameter


Return:

JSON: List of diagnostic parameters available for controller


Error:

None


/v1/frames/<filter_id>

Methods:

GET, POST


Inputs:

filter_id: Decimal or Hex (0x prefix) formatted arbitration ID


Return:

JSON: List of CAN Frame Objects matching the filter_id


Error:

None


/v1/frames/<filter_id>/<prop>

Methods:

GET, POST


Inputs:

filter_id: Decimal or Hex (0x prefix) formatted arbitration ID

prop: Property of CAN Frame Object


Return:

JSON: List of CAN Frame Objects matching the filter_id and specified prop


Error:

None


/v1/gauge/<signal_description>

Methods:

GET, POST


Inputs:

signal_description: Description of requested signal


Arguments:

delay: Float, loop delay for sending signal updates


Return:

HTML: Google Gauge representing the requested signal


Error:

None


/v1/gauges/<signal_description_list>

Methods:

GET, POST


Inputs:

signal_description_list: Comma separated list of descriptions of requested signals


Arguments:

delay: Float, loop delay for sending signal updates


Return:

HTML: Google Gauges representing the requested signals


Error:

None


/v1/tables/<signal_description_list>

Methods:

GET, POST


Inputs:

signal_description_list: Comma separated list of descriptions of requested signals


Arguments:

delay: Float, loop delay for sending signal updates


Return:

HTML: Google Table representing the requested signals


Error:

None


/v1/stream/<signal_description>

Methods:

GET, POST


Inputs:

signal_description: Signal description of requested signal stream


Return:

JSON: Server Side Event stream of requested signal. ‘value’ and ‘timestamp’


Error:

None


/v1/stream/<signal_description>/<float:delay>

Methods:

GET, POST


Inputs:

signal_description: Signal description of requested signal stream

delay: Float, loop delay for event messages


Return:

JSON: Server Side Event stream of requested signal. ‘value’ and ‘timestamp’


Error:

None


/v1/streams/<signal_description_list>

Methods:

GET, POST


Inputs:

signal_description_list: Comma separated signal descriptions of requested signals stream


Return:

JSON: Server Side Event stream of requested signals. ‘value’ and ‘timestamp’


Error:

None


/v1/streams/<signal_description_list>/<float:delay>

Methods:

GET, POST


Inputs:

signal_description_list: Comma separated signal descriptions of requested signals stream

delay: Float, loop delay for event messages


Return:

JSON: Server Side Event stream of requested signals. ‘value’ and ‘timestamp’


Error:

None