View Source Cantastic.OBD2.Parameter (Cantastic v1.0.1)

Cantastic.OBD2.Parameter is a Struct used to represent one CAN OBD2 parameter.

Each received Cantastic.OBD2.Response contains a list of :parameters

The attributes are the following:

  • :name The paramter's name, as defined in your YAML file.
  • :id The paramter's, as defined in your YAML file.
  • :request_name The OBD2 request's name, as defined in your YAML file.
  • :raw_value The raw value received on the CAN network.
  • :unit The unit defined in your YAML file (String).
  • :kind The kind defined in your YAML file, one off:
    • :decimal
    • :integer

Summary

Functions

to_string(parameter)

Returns a String representation of the parameter, used for debugging.

Functions

Link to this function

to_string(parameter)

View Source

Returns a String representation of the parameter, used for debugging.

Example 

iex> Cantastic.OBD2.Parameter.to_string(parameter)
"[OBD2 Parameter] my_request_name.parameter_name = 12"