lib/grizzly/zwave/commands/priority_route_report.ex

defmodule Grizzly.ZWave.Commands.PriorityRouteReport do
  @moduledoc """
  This command is used to advertise the current network route in use for an actual destination NodeID.

  Params:

    * `:node_id` - the NodeID destination for which the current network route is requested (required)

    * `:type` - the route type (required)

    * `:repeaters` - node ids of repeaters for the route (required)

    * `:speed` - speeds used for the route (required)

  """

  @behaviour Grizzly.ZWave.Command

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

  @type param ::
          {:node_id, byte}
          | {:type, NetworkManagementInstallationMaintenance.route_type()}
          | {:repeaters, [byte]}
          | {:speed, NetworkManagementInstallationMaintenance.speeds()}

  @impl true
  @spec new([param()]) :: {:ok, Command.t()}
  def new(params) do
    command = %Command{
      name: :priority_route_report,
      command_byte: 0x03,
      command_class: NetworkManagementInstallationMaintenance,
      params: params,
      impl: __MODULE__
    }

    {:ok, command}
  end

  @impl true
  @spec encode_params(Command.t()) :: binary()
  def encode_params(command) do
    node_id = Command.param!(command, :node_id)

    type_byte =
      Command.param!(command, :type)
      |> NetworkManagementInstallationMaintenance.route_type_to_byte()

    repeater_bytes =
      Command.param!(command, :repeaters)
      |> NetworkManagementInstallationMaintenance.repeaters_to_bytes()

    speeds_byte =
      Command.param!(command, :speed) |> NetworkManagementInstallationMaintenance.speeds_to_byte()

    <<node_id, type_byte>> <> repeater_bytes <> <<speeds_byte>>
  end

  @impl true
  @spec decode_params(binary()) :: {:ok, [param()]} | {:error, DecodeError.t()}
  def decode_params(<<node_id, type_byte, repeater_bytes::binary-size(4), speed_byte>>) do
    with {:ok, type} <- NetworkManagementInstallationMaintenance.route_type_from_byte(type_byte),
         {:ok, speeds} <- NetworkManagementInstallationMaintenance.speeds_from_byte(speed_byte) do
      {:ok,
       [
         node_id: node_id,
         type: type,
         speed: speeds,
         repeaters: NetworkManagementInstallationMaintenance.repeaters_from_bytes(repeater_bytes)
       ]}
    else
      {:error, %DecodeError{} = decode_error} ->
        {:error, %DecodeError{decode_error | command: :priority_route_report}}
    end
  end
end