grizzly v0.6.4 Grizzly.CommandClass.Time.OffsetSet View Source

Command module for working with TIME OFFSET_SET command.

command options:

  • :sign_tzo - This field is used to indicate the sign (plus or minus) to apply to the Hour TZO and Minute TZO field
  • :hour_tzo - This field is used to indicate the number of hours that the originating time zone deviates from UTC
  • :minute_tzo - This field is used to indicate the number of minutes that the originating time zone deviates UTC
  • :sign_offset_dst - This field is used to indicate the sign (plus or minus) for the Minute Offset DST field to apply to the current time while in the Daylight Saving Time
  • :minute_offset_dst - This field MUST indicate the number of minutes by which the current time is to be adjusted when Daylight Saving Time starts
  • :month_start_dst - This field MUST indicate the month of the year when Daylight Saving Time starts
  • :day_end_dst - This field MUST indicate the day of the month when Daylight Saving Time starts
  • :hour_start_dst - This field MUST indicate the hour of the day when Daylight Saving Time starts
  • :month_end_dst - This field MUST indicate the month of the year when Daylight Saving Time ends
  • :day_end_dst - This field MUST indicate the day of the month when Daylight Saving Time ends
  • :seq_number - The sequence number for the Z/IP Packet
  • :retries - The number times to retry 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()}
  | {:value, Grizzly.CommandClass.Time.offset()}

Link to this type

t() View Source
t() :: %Grizzly.CommandClass.Time.OffsetSet{
  retries: non_neg_integer(),
  seq_number: Grizzly.seq_number(),
  value: Grizzly.CommandClass.Time.offset()
}

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, arg2) View Source
handle_response(t(), Grizzly.Packet.t()) ::
  {:continue, t()}
  | {:done, {:error, :nack_response}}
  | {:done, Grizzly.CommandClass.Time.offset()}
  | {: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.