# 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: `DeviceEndpoint`

  Representation of an actuator

  static from_api_response(response_entry: Dict) → 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, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

  Bases: `Enum`

  ARMED_P1 = 1
  ARMED_P1_P2 = 3
  ARMED_P2 = 2
  ARMED_TOTALLY = 4
  NOT_ARMED = 0

class elmax_api.model.alarm_status.AlarmStatus(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

  Bases: `Enum`

  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: AlarmStatus, armed_status: AlarmArmStatus, available_statuses: List[AlarmStatus], available_arm_statuses: List[AlarmArmStatus])

  Bases: `DeviceEndpoint`

  Representation of an Area configuration

  property armed_status: AlarmArmStatus

    Current alarm arm status

    Returns: AlarmArmStatus

  property available_arm_statuses: List[AlarmArmStatus]

    Supported list of available alarm arm-statutes Returns:

  property available_statuses: List[AlarmStatus]

    Supported list of available alarm statuses Returns:

  static from_api_response(response_entry: Dict) → Area

    Create a new area configuration object from the API json response

  property status: AlarmStatus

    Current alarm status.

    Returns: AlarmStatus

## elmax_api.model.command module

class elmax_api.model.command.AreaCommand(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

  Bases: `Command`

  ARM_P1 = 1
  ARM_P1_P2 = 3
  ARM_P2 = 2
  ARM_TOTALLY = 4
  DISARM = 0

class elmax_api.model.command.Command(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

  Bases: `Enum`

class elmax_api.model.command.CoverCommand(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

  Bases: `Command`

  DOWN = 2
  UP = 1

class elmax_api.model.command.SceneCommand(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

  Bases: `Command`

  TRIGGER_SCENE = 'on'

class elmax_api.model.command.SwitchCommand(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

  Bases: `Command`

  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: CoverStatus)

  Bases: `DeviceEndpoint`

  Representation of a cover

  static from_api_response(response_entry: Dict) → Cover

    Create a new cover object from the API json response

  property position: int
  property status: CoverStatus

## elmax_api.model.cover_status module

class elmax_api.model.cover_status.CoverStatus(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

  Bases: `Enum`

  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) → 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: `DeviceEndpoint`

  Representation of a Group configuration

  static from_api_response(response_entry: Dict) → 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[Zone], actuators: List[Actuator], areas: List[Area], groups: List[Group], scenes: List[Scene], covers: List[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[Actuator]
  property all_endpoints: List[DeviceEndpoint]
  property areas: List[Area]
  property cover_feature: bool
  property covers: List[Cover]
  static from_api_response(response_entry: Dict) → EndpointStatus

    Create a new endpoint status object from the API json response

  property groups: List[Group]
  property push_feature: bool
  property release: str
  property scene_feature: bool
  property scenes: List[Scene]
  property zones: List[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) → 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[Zone], actuators: List[Actuator], areas: List[Area], groups: List[Group], scenes: List[Scene], covers: List[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[Actuator]
  property all_endpoints: List[DeviceEndpoint]
  property areas: List[Area]
  property cover_feature: bool
  property covers: List[Cover]
  static from_api_response(response_entry: Dict) → PanelStatus

    Create a new panel status object from the API json response

  property groups: List[Group]
  property panel_id: str
  property push_feature: bool
  property release: str
  property scene_feature: bool
  property scenes: List[Scene]
  property user_email: str
  property zones: List[Zone]

## elmax_api.model.scene module

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

  Bases: `DeviceEndpoint`

  Representation of a Scene configuration

  static from_api_response(response_entry: Dict) → 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: `DeviceEndpoint`

  Representation of a zone configuration

  property excluded: bool
  static from_api_response(response_entry: Dict) → Zone

    Create a new zone configuration object from the API json response

  property opened: bool

## Module contents