auto_api v0.1.0 AutoApi.TheftAlarmCapability View Source
Basic settings for TheftAlarm Capability
iex> alias AutoApi.TheftAlarmCapability, as: T
iex> T.identifier
<<0x00, 0x46>>
iex> T.name
:theft_alarm
iex> T.description
"Theft Alarm"
iex> T.command_name(0x00)
:get_theft_alarm_state
iex> T.command_name(0x01)
:theft_alarm_state
iex> T.command_name(0x02)
:set_theft_alarm_state
iex> length(T.properties)
1
iex> T.properties
[{1, :theft_alarm}]
Link to this section Summary
Functions
Deprecated. Use API level 5 and above
Deprecated. Use API level 5 and above
Returns the command module related to this capability
Return commands id based on atom
Returns commands readable name
Returns map of commands id and thier name
Returns capability’s description: Theft Alarm
Retunrs capability’s identifier: <<0x0, 0x46>>
Returns capability’s unique name: theft_alarm
Retunrs properties under Theft Alarm:
[{0x1, :theft_alarm}]
Returns the command module related to this capability
Returns binary value of capability based on list of available supported capabilities
Returns list of supported sub capability based on binary value
Deprecated. Use API level 5 and above
Deprecated. Use API level 5 and above
Link to this section Types
command_type() :: :get_theft_alarm_state | :theft_alarm_state | :set_theft_alarm_state
Link to this section Functions
Deprecated. Use API level 5 and above.
Retunrs capabilities under Theft Alarm:
[]
Deprecated. Use API level 5 and above.
Returns capability size: 1
Returns the command module related to this capability
command_id(AutoApi.TheftAlarmCapability.command_type()) :: integer() | nil
Return commands id based on atom
command_name(integer()) :: AutoApi.TheftAlarmCapability.command_type() | nil
Returns commands readable name.
Available commands:
%{0x0 => :get_theft_alarm_state, 0x1 => :theft_alarm_state, 0x2 => :set_theft_alarm_state}
Returns map of commands id and thier name
[{0x0, :get_theft_alarm_state}, {0x1, :theft_alarm_state}, {0x2, :set_theft_alarm_state}]
Returns capability’s description: Theft Alarm
Retunrs capability’s identifier: <<0x0, 0x46>>
Returns capability’s unique name: theft_alarm
Retunrs properties under Theft Alarm:
[{0x1, :theft_alarm}]
Returns the command module related to this capability
Returns binary value of capability based on list of available supported capabilities
to_map(binary()) :: [command_type()] :: [map()]
Returns list of supported sub capability based on binary value
Level 5:
ie> HmAutoApi.DoorLocksCapability.to_map(<<0x00, 0x20, 0x01, 0x00, 0x02>>)
[:lock_state, :get_lock_state, :lock_unlock_doors]
Level 4:
ie> HmAutoApi.DoorLocksCapability.to_map(<<0x1, 0x0>>)
[%{bin: <<0x00>>, name: "Unavailable", atom: :unavailable, title: ""}]
Deprecated. Use API level 5 and above.
Deprecated. Use API level 5 and above.