grizzly v0.8.2 Grizzly.CommandClass.ScheduleEntryLock.YearDaySet View Source

Command for working with SCHEDULE_ENTRY_LOCK command class YEAR_DAY_SET command

Command Options:

  • :action - The action either to erase or to modify the slot
  • :slot_id - The schedule slot id
  • :user_id - The schedule user id for the EntryLock
  • :start_year - A value from 0 to 99 that represents the 2 year in the century
  • :start_month - A value from 1 to 12 that represents the month in a year
  • :start_day - A value from 1 to 31 that represents the date of the month
  • :start_hour - A value from 0 to 23 representing the starting hour of the time fence
  • :start_minute - A value from 0 to 59 representing the starting minute of the time fence
  • :stop_year - A value from 0 to 99 that represents the 2 year in the century
  • :stop_month - A value from 1 to 12 that represents the month in a year
  • :stop_day - A value from 1 to 31 that represents the date of the month
  • :stop_hour - A value from 0 to 23 representing the starting hour of the time fence
  • :stop_minute - A value from 0 to 59 representing the starting minute of the time fence
  • :seq_number - The sequence number used in the Z/IP packet
  • :retries - The number of attempts to send the command (default 2)

Link to this section Summary

Link to this section Types

Link to this type

opt() View Source
opt() ::
  {:seq_number, Grizzly.seq_number()}
  | {:retries, non_neg_integer()}
  | {:user_id, non_neg_integer()}
  | {:slot_id, non_neg_integer()}
  | {:action, Grizzly.CommandClass.ScheduleEntryLock.enable_action()}
  | {:start_year, non_neg_integer()}
  | {:start_month, non_neg_integer()}
  | {:start_hour, non_neg_integer()}
  | {:start_minute, non_neg_integer()}
  | {:stop_year, non_neg_integer()}
  | {:stop_month, non_neg_integer()}
  | {:stop_hour, non_neg_integer()}
  | {:stop_minute, non_neg_integer()}

Link to this type

t() View Source
t() :: %Grizzly.CommandClass.ScheduleEntryLock.YearDaySet{
  action: Grizzly.CommandClass.ScheduleEntryLock.enable_action(),
  retries: non_neg_integer(),
  seq_number: Grizzly.seq_number(),
  slot_id: non_neg_integer(),
  start_day: non_neg_integer(),
  start_hour: non_neg_integer(),
  start_minute: non_neg_integer(),
  start_month: non_neg_integer(),
  start_year: non_neg_integer(),
  stop_day: non_neg_integer(),
  stop_hour: non_neg_integer(),
  stop_minute: non_neg_integer(),
  stop_month: non_neg_integer(),
  stop_year: non_neg_integer(),
  user_id: non_neg_integer()
}

Link to this section Functions

Link to this function

encode(command) View Source
encode(t()) :: {:ok, binary()} | {:error, Grizzly.Command.EncodeError.t()}

Callback implementation for Grizzly.Command.encode/1.

Link to this function

handle_response(command, packet) View Source
handle_response(t(), Grizzly.Packet.t()) ::
  {:continue, t()}
  | {:done, {:error, :nack_response}}
  | {:done, :ok}
  | {:retry, t()}

Callback implementation for Grizzly.Command.handle_response/2.

Link to this function

init(opts) View Source
init([opt()]) :: {:ok, t()}

Callback implementation for Grizzly.Command.init/1.