sound_switch_tone_play_report.ex

defmodule Grizzly.ZWave.Commands.SoundSwitchTonePlayReport do
  @moduledoc """
  This command is used to instruct a supporting node to play (or stop playing) a
  tone.

  ## Params

  * `:tone_identifier` - The tone identifier being played. If the value is 0,
    no tone is currently being played OR the configured volume for the playing
    tone is 0.

  * `:volume` (v2) - The volume the tone is currently being played at.
  """

  @behaviour Grizzly.ZWave.Command

  alias Grizzly.ZWave.{Command, DecodeError}
  alias Grizzly.ZWave.CommandClasses.SoundSwitch

  @type param :: {:tone_identifier, 0..255}

  @impl Grizzly.ZWave.Command
  @spec new([param()]) :: {:ok, Command.t()}
  def new(params) do
    command = %Command{
      name: :sound_switch_tone_play_report,
      command_byte: 0x0A,
      command_class: SoundSwitch,
      params: params,
      impl: __MODULE__
    }

    {:ok, command}
  end

  @impl Grizzly.ZWave.Command
  @spec encode_params(Command.t()) :: binary()
  def encode_params(command) do
    tone_identifier = Command.param!(command, :tone_identifier)
    volume = Command.param(command, :volume)

    if is_nil(volume) do
      # V1
      <<tone_identifier::8>>
    else
      # V2
      <<tone_identifier::8, volume::8>>
    end
  end

  @impl Grizzly.ZWave.Command
  @spec decode_params(binary()) :: {:ok, [param()]} | {:error, DecodeError.t()}
  def decode_params(<<tone_identifier::8, volume::8>>) do
    {:ok, [tone_identifier: tone_identifier, volume: volume]}
  end

  def decode_params(<<tone_identifier::8>>) do
    {:ok, [tone_identifier: tone_identifier]}
  end
end