Packages
grizzly
8.15.0
9.1.4
9.1.2
9.1.1
9.1.0
9.0.0
8.15.3
8.15.2
8.15.1
8.15.0
8.14.0
8.13.0
8.12.0
8.11.3
8.11.2
8.11.1
8.11.0
8.10.0
8.9.0
8.8.1
8.8.0
8.7.1
8.7.0
8.6.12
8.6.11
8.6.10
8.6.9
8.6.8
8.6.7
retired
8.6.6
8.6.5
8.6.4
8.6.3
8.6.2
8.6.1
8.6.0
8.5.3
8.5.2
8.5.1
8.5.0
8.4.0
8.3.0
8.2.3
8.2.2
8.2.1
8.2.0
8.1.0
8.0.1
8.0.0
7.4.3
7.4.2
7.4.1
7.4.0
7.3.0
7.2.0
7.1.4
7.1.3
7.1.2
7.1.1
7.1.0
7.0.4
7.0.3
7.0.2
7.0.1
7.0.0
6.8.8
6.8.7
6.8.6
6.8.5
6.8.4
6.8.3
6.8.2
6.8.1
6.8.0
6.7.1
6.7.0
6.6.1
6.6.0
6.5.1
6.5.0
6.4.0
6.3.0
6.2.0
6.1.1
6.1.0
6.0.1
6.0.0
5.4.1
5.4.0
5.3.0
5.2.8
5.2.7
5.2.6
5.2.5
5.2.4
5.2.3
5.2.2
5.2.1
5.2.0
5.1.2
5.1.1
5.1.0
5.0.2
5.0.1
5.0.0
4.0.1
4.0.0
3.0.0
2.1.0
2.0.0
1.0.1
1.0.0
0.22.7
0.22.6
0.22.5
0.22.4
0.22.3
0.22.2
0.22.1
0.22.0
0.21.1
0.21.0
0.20.2
0.20.1
0.20.0
0.19.1
0.19.0
0.18.3
0.18.2
0.18.1
0.18.0
0.17.7
0.17.6
0.17.5
0.17.4
0.17.3
0.17.2
0.17.1
0.17.0
0.16.2
0.16.1
0.16.0
0.15.11
0.15.10
0.15.9
0.15.8
0.15.7
0.15.6
0.15.5
0.15.4
0.15.3
0.15.2
0.15.1
0.15.0
0.14.8
0.14.7
0.14.6
0.14.5
0.14.4
0.14.3
0.14.2
0.14.1
0.14.0
0.13.0
0.12.3
0.12.2
0.12.1
0.12.0
0.11.0
0.10.3
0.10.2
0.10.1
0.10.0
0.9.0
0.9.0-rc.4
0.9.0-rc.3
0.9.0-rc.2
0.9.0-rc.1
0.9.0-rc.0
0.8.8
0.8.7
0.8.6
0.8.5
0.8.4
0.8.3
0.8.2
0.8.1
0.8.0
0.7.0
0.6.6
0.6.5
0.6.4
0.6.3
0.6.2
0.6.1
0.6.0
0.5.0
0.4.3
0.4.2
Elixir Z-Wave library
Current section
Files
Jump to
Current section
Files
lib/grizzly/events.ex
defmodule Grizzly.Events do
@moduledoc """
Pubsub registry for Grizzly events other than Z-Wave commands from devices.
## Events
### Ready
This event is emitted when Z/IP Gateway has started and Grizzly is ready to
process commands.
### OTW Firmware Update
This event is emitted when updating the firmware on the Z-Wave module. The
payload indicates the status. See `t:Grizzly.ZWaveFirmware.update_status/0`.
### Serial API Status
This event is emitted when the serial API appears to be unresponsive (or recovers
from this state) based on Z/IP Gateway's log output.
"""
alias Grizzly.Report
alias Grizzly.ZWave.Command
import Grizzly.NodeId
@type event :: :ready | :otw_firmware_update | :serial_api_status
@type subject :: event() | Grizzly.command() | Grizzly.node_id() | {:node, Grizzly.node_id()}
@type subscriptions :: [
event: list(event()),
commands: list(Grizzly.command()),
nodes: list(Grizzly.node_id())
]
@type subscribe_opt :: {:firehose, boolean()}
@type subscribe_opts :: [subscribe_opt()]
defguardp is_event(event) when event in [:ready, :otw_firmware_update, :serial_api_status]
@spec child_spec(any()) :: Supervisor.child_spec()
def child_spec(_) do
Registry.child_spec(keys: :duplicate, name: __MODULE__)
end
@doc """
List a process's subscriptions.
"""
@spec subscriptions(GenServer.server()) :: subscriptions()
def subscriptions(pid \\ self()) do
pid = if(is_pid(pid), do: pid, else: GenServer.whereis(pid))
subscriptions =
Registry.select(Grizzly.Events, [
{
{:"$1", :"$2", :_},
[{:==, :"$2", pid}],
[:"$1"]
}
])
subscriptions =
for key <- subscriptions, reduce: [] do
acc ->
{type, key} =
case key do
{:node, node_id} -> {:nodes, node_id}
e when is_event(e) -> {:events, e}
c -> {:commands, c}
end
Keyword.update(acc, type, [key], fn current -> [key | current] end)
end
for {type, keys} <- subscriptions do
{type, Enum.sort(keys)}
end
end
@doc """
Subscribe to an event, all commands from a node, or a specific command from any
node.
## Options
* `:firehose` - Normally, subscribers will only receive unsolicited commands
from the node (or command) they are subscribed to. If this option is set to
true, subscribers will receive all incoming commands that match, including
responses to commands sent via `Grizzly.send_command/4`. Defaults to `false`.
"""
@spec subscribe(subject() | [subject()], subscribe_opts()) :: :ok
def subscribe(subject, opts \\ [])
def subscribe([subject | subjects], opts) do
subscribe(subject, opts)
subscribe(subjects, opts)
end
def subscribe([], _opts), do: :ok
def subscribe(event, _opts) when is_event(event) do
_ = Registry.register(__MODULE__, key(event), [])
:ok
end
def subscribe(subject, opts) do
opts = opts |> Map.new() |> Map.take([:firehose])
_ = Registry.register(__MODULE__, key(subject), opts)
:ok
end
@doc """
Unsubscribe from one or more Grizzly events.
"""
@spec unsubscribe(subject() | [subject()]) :: :ok
def unsubscribe(subject)
def unsubscribe(node_id) when is_node_id(node_id),
do: unsubscribe({:node, node_id})
def unsubscribe(subjects) when is_list(subjects),
do: Enum.each(subjects, &unsubscribe/1)
def unsubscribe(subject) do
_ = Registry.unregister(__MODULE__, subject)
:ok
end
@doc false
@spec broadcast_event(event(), term()) :: :ok
def broadcast_event(event, payload) when is_event(event) do
Registry.dispatch(__MODULE__, key(event), fn entries ->
for {pid, _} <- entries do
send(pid, {:grizzly, event, payload})
end
end)
end
@doc false
@spec broadcast_report(Report.t()) :: :ok
def broadcast_report(%Report{command: %Command{}} = report) do
report
|> __subs_for_report__()
|> Enum.each(&send(&1, {:grizzly, :report, report}))
end
def broadcast_report(_), do: :ok
@doc false
@spec __subs_for_report__(Report.t()) :: [pid()]
def __subs_for_report__(
%Report{node_id: node_id, command: %Command{name: command_name}} = report
) do
guards =
if report.type == :unsolicited do
match_spec_guards_for_unsolicited(node_id, command_name)
else
match_spec_guards_for_firehose(node_id, command_name)
end
subscribers =
Registry.select(Grizzly.Events, [
{
{:"$1", :"$2", :"$3"},
guards,
[{{:"$1", :"$2", :"$3"}}]
}
])
# Reduce to a list of unique pids
subscribers
|> Enum.map(&elem(&1, 1))
|> Enum.uniq()
end
defp match_spec_guards_for_unsolicited(node_id, command_name) do
command_name_match = {:==, :"$1", key(command_name)}
node_id_match = {:==, :"$1", key(node_id)}
[{:orelse, command_name_match, node_id_match}]
end
defp match_spec_guards_for_firehose(node_id, command_name) do
[key_match] = match_spec_guards_for_unsolicited(node_id, command_name)
# erlang and elixir have opposite argument orders for map_get
is_firehose = {:==, {:map_get, :firehose, :"$3"}, true}
[{:andalso, key_match, is_firehose}]
end
defp key({:virtual, node_id}), do: "node:virtual:#{node_id}"
defp key(key) when is_zwave_node_id(key), do: "node:#{key}"
defp key(key) when is_event(key), do: "event:#{key}"
defp key(key), do: "command:#{key}"
end