AutoApi.KeyfobPositionCapability (auto_api v13.2.0) View Source
Basic settings for KeyfobPosition Capability
iex> alias AutoApi.KeyfobPositionCapability, as: K
iex> K.identifier
<<0x00, 0x48>>
iex> K.name
:keyfob_position
iex> K.description
"Keyfob Position"
iex> length(K.properties)
6
iex> List.first(K.properties)
{0x01, :location}
Link to this section Summary
Functions
Returns whether the capability requires authorization to be queried
Returns the command module related to this capability
Returns whether the property is deprecated.
Returns capability's description: Keyfob Position
Retunrs capability's identifier: <<0x0, 0x48>>
Returns whether the property is multiple, that is if it can contain multiple values.
Returns capability's unique name: keyfob_position
Returns properties under Keyfob Position
Returns the ID of a property given its name.
Returns the name of a property given its ID.
Returns the list of setters defined for the capability.
Returns the state module related to this capability
Returns which properties are included in the State specification.
Link to this section Functions
Specs
authorization?() :: boolean()
Returns whether the capability requires authorization to be queried
Examples
iex> AutoApi.DiagnosticsCapability.authorization?()
true
iex> AutoApi.HistoricalCapability.authorization?()
false
Specs
command() :: atom()
Returns the command module related to this capability
Specs
Returns whether the property is deprecated.
Example
iex> AutoApi.HoodCapability.deprecated?(:lock)
false
iex> AutoApi.DiagnosticsCapability.deprecated?(:mileage)
true
Specs
description() :: String.t()
Returns capability's description: Keyfob Position
Specs
identifier() :: binary()
Retunrs capability's identifier: <<0x0, 0x48>>
Specs
Returns whether the property is multiple, that is if it can contain multiple values.
Example
iex> AutoApi.KeyfobPositionCapability.multiple?(:location)
false
Specs
name() :: atom()
Returns capability's unique name: keyfob_position
Specs
properties() :: [tuple()]
Returns properties under Keyfob Position:
[{0x1, :location}, {0xA0, :nonce}, {0xA1, :vehicle_signature}, {0xA2, :timestamp}, {0xA3, :vin}, {0xA4, :brand}]
Specs
Returns the ID of a property given its name.
Example
iex> AutoApi.KeyfobPositionCapability.property_id(:location)
1
Specs
Returns the name of a property given its ID.
Example
iex> AutoApi.KeyfobPositionCapability.property_name(1)
:location
Specs
Returns the list of setters defined for the capability.
The list is a Keyword
with the setter name as a key and as value
a tuple with three elements:
- mandatory properties
- optional properties
- constants
Example
iex> AutoApi.KeyfobPositionCapability.setters()
[]
Returns the state module related to this capability
Specs
state_properties() :: [atom()]
Returns which properties are included in the State specification.
Universal properties are always included
Examples
iex> AutoApi.SeatsCapability.state_properties()
[:persons_detected, :seatbelts_state, :nonce, :vehicle_signature, :timestamp, :vin, :brand]
iex> AutoApi.WakeUpCapability.state_properties()
[:nonce, :vehicle_signature, :timestamp, :vin, :brand]