Skip to content

Commit

Permalink
WIP: Updated a description of Is Active capability
Browse files Browse the repository at this point in the history
  • Loading branch information
s-kostyuk committed Mar 20, 2018
1 parent 9765e8c commit 85513c3
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions docs/source/developer/capability_list.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,10 +90,18 @@ Is Active
otherwise.


Has State devices are devices that have the ``state`` property. The
value of the property is some string which is directly mapped to one
of the device states. The exact set of possible states is defined by
a set of Capabilities provided by the device.
Is Active devices are devices that have the ``is_active`` property.
The value of this property is a boolean with ``true`` mapped to the
set of "active" states (i.e. working, acting, turned on) and ``false``
mapped to the set of "inactive" states (i.e. not working, not acting,
turned off, stopped).

Is Active Capability must to be implemented if and only if the current
state of the device can be clearly mapped to either "active" or
"inactive" state.

Actuator Is Active devices must to implement such methods as ``toggle``,
``activate`` and ``deactivate``.


On/Off
Expand Down

0 comments on commit 85513c3

Please sign in to comment.