View Source Grizzly.ZWave.CommandClasses.UserCode (grizzly v8.6.6)

Command Class for working with user codes

Summary

Types

extended_user_code()

@type extended_user_code() :: %{
  user_id: extended_user_code(),
  user_id_status: user_id_status(),
  user_code: String.t()
}

extended_user_id()

@type extended_user_id() :: 0..65535

keypad_mode()

@type keypad_mode() :: :normal | :vacation | :privacy | :lockout | :unknown

user_id_status()

@type user_id_status() ::
  :available
  | :occupied
  | :disabled
  | :messaging
  | :passage
  | :status_not_available
  | :unknown
  | byte()

Functions

decode_extended_user_codes(user_codes_bin)

@spec decode_extended_user_codes(binary()) ::
  {user_codes :: [extended_user_code()], remainder :: binary()}

encode_extended_user_code(user_code)

keypad_mode_from_byte(arg1)

@spec keypad_mode_from_byte(byte()) :: keypad_mode()

keypad_mode_to_byte(atom)

@spec keypad_mode_to_byte(keypad_mode()) :: 0 | 1 | 2 | 3

user_id_status_from_byte(v)

@spec user_id_status_from_byte(byte()) :: user_id_status()

user_id_status_to_byte(v)

@spec user_id_status_to_byte(user_id_status()) :: byte()