Reference

Class `DiscreteIconPlaceHolder`

Discrete sensors SVG placeholder.

Inherits from:

IconPlaceHolder

These placeholders will contain a dynamic icon to represent the value of a discrete sensor. Relevant sensors are blinds, door switches, etc.

Info:

edit Alexis BRENON brenon.alexis+arcades@gmail.com

See also:

IconPlaceHolder

Metamethods

__init ( element, spec )
Constructor.
Parameters:
- Doc element
  XML element to parse
- table spec
  PlaceHolder's specification extracted from SVG description

Public Methods

get_random_value ()
Get a random value from the placeholder.

The value is 0 or 1.

Overrides: PlaceHolder:get_random_value

Returns:
- integer 0 or 1
set_value ( value )
Change current value of the placeholder.

Overrides: PlaceHolder:set_value

Parameters:
- number value
  New value to apply
Returns:
- DiscreteIconPlaceHolder self
- boolean Is the value modified

Private Methods

_prepare_string ( element )
Initialize string and placed_values from given XML element.

Overrides: PlaceHolder._prepare_string

Parameters:
- Doc element
  XML element