Grizzly.Associations (grizzly v8.11.0)
View SourceStorage for Z-Wave association groups. Supports both standard and multi channel associations.
Summary
Functions
Returns a specification to start this module under a supervisor.
Delete all the associations
Delete all the nodes from the grouping
Delete the nodes from each association group
Delete the specified nodes from the association grouping
Get an association by the grouping id
Get all the associations
Save the node ids to the grouping id
Start the Associations server
Types
@type grouping_id() :: byte()
Functions
Returns a specification to start this module under a supervisor.
See Supervisor
.
@spec delete_all(GenServer.server()) :: :ok
Delete all the associations
@spec delete_all_nodes_from_grouping(GenServer.server(), grouping_id()) :: :ok
Delete all the nodes from the grouping
@spec delete_nodes_from_all_groupings(GenServer.server(), [Grizzly.ZWave.node_id()]) :: :ok
Delete the nodes from each association group
@spec delete_nodes_from_grouping(GenServer.server(), grouping_id(), [ Grizzly.ZWave.node_id() ]) :: :ok | {:error, :invalid_grouping_id}
Delete the specified nodes from the association grouping
@spec get(GenServer.server(), grouping_id()) :: Grizzly.Associations.Association.t() | nil
Get an association by the grouping id
@spec get_all(GenServer.server()) :: [Grizzly.Associations.Association.t()]
Get all the associations
@spec save(GenServer.server(), grouping_id(), [Grizzly.ZWave.node_id()]) :: :ok | :error
Save the node ids to the grouping id
@spec start_link(Grizzly.Options.t(), GenServer.options()) :: GenServer.on_start()
Start the Associations server
If you pass the GenServer option for a name you can access the server with
that name. However, if no name is passed to the server_opts
then it will
fallback to using the Grizzly.Associations
module name