elmax_api.model package

Submodules

elmax_api.model.actuator module

class elmax_api.model.actuator.Actuator(endpoint_id: str, visible: bool, index: int, name: str, opened: bool)

Bases: elmax_api.model.endpoint.DeviceEndpoint

Representation of an actuator

static from_api_response(response_entry: Dict) → elmax_api.model.actuator.Actuator

Create a new actuator object from the API json response

property opened: bool

elmax_api.model.alarm_status module

class elmax_api.model.alarm_status.AlarmArmStatus(value)

Bases: enum.Enum

An enumeration.

ARMED_P1 = 1

ARMED_P1_P2 = 3

ARMED_P2 = 2

ARMED_TOTALLY = 4

NOT_ARMED = 0

class elmax_api.model.alarm_status.AlarmStatus(value)

Bases: enum.Enum

An enumeration.

ARMED_STANDBY = 2

NOT_ARMED_NOT_ARMABLE = 1

NOT_ARMED_NOT_TRIGGERED = 0

TRIGGERED = 3

elmax_api.model.area module

class elmax_api.model.area.Area(endpoint_id: str, visible: bool, index: int, name: str, status: elmax_api.model.alarm_status.AlarmStatus, armed_status: elmax_api.model.alarm_status.AlarmArmStatus, available_statuses: List[elmax_api.model.alarm_status.AlarmStatus], available_arm_statuses: List[elmax_api.model.alarm_status.AlarmArmStatus])

Bases: elmax_api.model.endpoint.DeviceEndpoint

Representation of an Area configuration

property armed_status: elmax_api.model.alarm_status.AlarmArmStatus

Current alarm arm status

Returns: AlarmArmStatus

property available_arm_statuses: List[elmax_api.model.alarm_status.AlarmArmStatus]

Supported list of available alarm arm-statutes Returns:

property available_statuses: List[elmax_api.model.alarm_status.AlarmStatus]

Supported list of available alarm statuses Returns:

static from_api_response(response_entry: Dict) → elmax_api.model.area.Area

Create a new area configuration object from the API json response

property status: elmax_api.model.alarm_status.AlarmStatus

Current alarm status.

Returns: AlarmStatus

elmax_api.model.command module

class elmax_api.model.command.AreaCommand(value)

Bases: elmax_api.model.command.Command

An enumeration.

ARM_P1 = 1

ARM_P1_P2 = 3

ARM_P2 = 2

ARM_TOTALLY = 4

DISARM = 0

class elmax_api.model.command.Command(value)

Bases: enum.Enum

An enumeration.

class elmax_api.model.command.CoverCommand(value)

Bases: elmax_api.model.command.Command

An enumeration.

DOWN = 2

UP = 1

class elmax_api.model.command.SceneCommand(value)

Bases: elmax_api.model.command.Command

An enumeration.

TRIGGER_SCENE = 'on'

class elmax_api.model.command.SwitchCommand(value)

Bases: elmax_api.model.command.Command

An enumeration.

TURN_OFF = 'off'

TURN_ON = 'on'

elmax_api.model.cover module

class elmax_api.model.cover.Cover(endpoint_id: str, visible: bool, index: int, name: str, position: int, status: elmax_api.model.cover_status.CoverStatus)

Bases: elmax_api.model.endpoint.DeviceEndpoint

Representation of a cover

static from_api_response(response_entry: Dict) → elmax_api.model.cover.Cover

Create a new cover object from the API json response

property position: int

property status: elmax_api.model.cover_status.CoverStatus

elmax_api.model.cover_status module

class elmax_api.model.cover_status.CoverStatus(value)

Bases: enum.Enum

An enumeration.

DOWN = 'down'

IDLE = 'stop'

UP = 'up'

elmax_api.model.endpoint module

class elmax_api.model.endpoint.DeviceEndpoint(endpoint_id: str, visible: bool, index: int, name: str)

Bases: object

property endpoint_id: str

static from_api_response(response_entry: Dict) → elmax_api.model.endpoint.DeviceEndpoint

Create a new area configuration object from the API json response

property index: int

property name: str

property visible: bool

elmax_api.model.goup module

class elmax_api.model.goup.Group(endpoint_id: str, visible: bool, index: int, name: str)

Bases: elmax_api.model.endpoint.DeviceEndpoint

Representation of a Group configuration

static from_api_response(response_entry: Dict) → elmax_api.model.goup.Group

Create a new group configuration object from the API json response

elmax_api.model.panel module

class elmax_api.model.panel.EndpointStatus(release: str, cover_feature: bool, scene_feature: bool, zones: List[elmax_api.model.zone.Zone], actuators: List[elmax_api.model.actuator.Actuator], areas: List[elmax_api.model.area.Area], groups: List[elmax_api.model.goup.Group], scenes: List[elmax_api.model.scene.Scene], covers: List[elmax_api.model.cover.Cover], push_feature: bool, accessory_type: str, accessory_release: str, *args, **kwargs)

Bases: object

Representation of an endpoint status

property accessory_release: str

property accessory_type: str

property actuators: List[elmax_api.model.actuator.Actuator]

property all_endpoints: List[elmax_api.model.endpoint.DeviceEndpoint]

property areas: List[elmax_api.model.area.Area]

property cover_feature: bool

property covers: List[elmax_api.model.cover.Cover]

static from_api_response(response_entry: Dict) → elmax_api.model.panel.EndpointStatus

Create a new endpoint status object from the API json response

property groups: List[elmax_api.model.goup.Group]

property push_feature: bool

property release: str

property scene_feature: bool

property scenes: List[elmax_api.model.scene.Scene]

property zones: List[elmax_api.model.zone.Zone]

class elmax_api.model.panel.PanelEntry(devicehash: str, online: bool, name_by_user: Dict[str, str])

Bases: object

Representation of an available control panel.

static from_api_response(response_entry: Dict) → elmax_api.model.panel.PanelEntry

Create a new control panel from the API json response

get_name_by_user(username: str) → str

property hash: str

property online: bool

class elmax_api.model.panel.PanelStatus(panel_id: str, user_email: str, release: str, cover_feature: bool, scene_feature: bool, zones: List[elmax_api.model.zone.Zone], actuators: List[elmax_api.model.actuator.Actuator], areas: List[elmax_api.model.area.Area], groups: List[elmax_api.model.goup.Group], scenes: List[elmax_api.model.scene.Scene], covers: List[elmax_api.model.cover.Cover], push_feature: bool, accessory_type: str, accessory_release: str, *args, **kwargs)

Bases: object

Representation of a panel status

property accessory_release: str

property accessory_type: str

property actuators: List[elmax_api.model.actuator.Actuator]

property all_endpoints: List[elmax_api.model.endpoint.DeviceEndpoint]

property areas: List[elmax_api.model.area.Area]

property cover_feature: bool

property covers: List[elmax_api.model.cover.Cover]

static from_api_response(response_entry: Dict) → elmax_api.model.panel.PanelStatus

Create a new panel status object from the API json response

property groups: List[elmax_api.model.goup.Group]

property panel_id: str

property push_feature: bool

property release: str

property scene_feature: bool

property scenes: List[elmax_api.model.scene.Scene]

property user_email: str

property zones: List[elmax_api.model.zone.Zone]

elmax_api.model.scene module

class elmax_api.model.scene.Scene(endpoint_id: str, visible: bool, index: int, name: str)

Bases: elmax_api.model.endpoint.DeviceEndpoint

Representation of a Scene configuration

static from_api_response(response_entry: Dict) → elmax_api.model.scene.Scene

Create a new scene configuration object from the API json response

elmax_api.model.zone module

class elmax_api.model.zone.Zone(endpoint_id: str, visible: bool, index: int, name: str, opened: bool, excluded: bool)

Bases: elmax_api.model.endpoint.DeviceEndpoint

Representation of a zone configuration

property excluded: bool

static from_api_response(response_entry: Dict) → elmax_api.model.zone.Zone

Create a new zone configuration object from the API json response

property opened: bool

Module contents