# elmax_api package

## Subpackages

- elmax_api.model package
  - Submodules
  - elmax_api.model.actuator module
    - `Actuator`
      - `Actuator.from_api_response()`
      - `Actuator.opened`
  - elmax_api.model.alarm_status module
    - `AlarmArmStatus`
      - `AlarmArmStatus.ARMED_P1`
      - `AlarmArmStatus.ARMED_P1_P2`
      - `AlarmArmStatus.ARMED_P2`
      - `AlarmArmStatus.ARMED_TOTALLY`
      - `AlarmArmStatus.NOT_ARMED`
    - `AlarmStatus`
      - `AlarmStatus.ARMED_STANDBY`
      - `AlarmStatus.NOT_ARMED_NOT_ARMABLE`
      - `AlarmStatus.NOT_ARMED_NOT_TRIGGERED`
      - `AlarmStatus.TRIGGERED`
  - elmax_api.model.area module
    - `Area`
      - `Area.armed_status`
      - `Area.available_arm_statuses`
      - `Area.available_statuses`
      - `Area.from_api_response()`
      - `Area.status`
  - elmax_api.model.command module
    - `AreaCommand`
      - `AreaCommand.ARM_P1`
      - `AreaCommand.ARM_P1_P2`
      - `AreaCommand.ARM_P2`
      - `AreaCommand.ARM_TOTALLY`
      - `AreaCommand.DISARM`
    - `Command`
    - `CoverCommand`
      - `CoverCommand.DOWN`
      - `CoverCommand.UP`
    - `SceneCommand`
      - `SceneCommand.TRIGGER_SCENE`
    - `SwitchCommand`
      - `SwitchCommand.TURN_OFF`
      - `SwitchCommand.TURN_ON`
  - elmax_api.model.cover module
    - `Cover`
      - `Cover.from_api_response()`
      - `Cover.position`
      - `Cover.status`
  - elmax_api.model.cover_status module
    - `CoverStatus`
      - `CoverStatus.DOWN`
      - `CoverStatus.IDLE`
      - `CoverStatus.UP`
  - elmax_api.model.endpoint module
    - `DeviceEndpoint`
      - `DeviceEndpoint.endpoint_id`
      - `DeviceEndpoint.from_api_response()`
      - `DeviceEndpoint.index`
      - `DeviceEndpoint.name`
      - `DeviceEndpoint.visible`
  - elmax_api.model.goup module
    - `Group`
      - `Group.from_api_response()`
  - elmax_api.model.panel module
    - `EndpointStatus`
      - `EndpointStatus.accessory_release`
      - `EndpointStatus.accessory_type`
      - `EndpointStatus.actuators`
      - `EndpointStatus.all_endpoints`
      - `EndpointStatus.areas`
      - `EndpointStatus.cover_feature`
      - `EndpointStatus.covers`
      - `EndpointStatus.from_api_response()`
      - `EndpointStatus.groups`
      - `EndpointStatus.push_feature`
      - `EndpointStatus.release`
      - `EndpointStatus.scene_feature`
      - `EndpointStatus.scenes`
      - `EndpointStatus.zones`
    - `PanelEntry`
      - `PanelEntry.from_api_response()`
      - `PanelEntry.get_name_by_user()`
      - `PanelEntry.hash`
      - `PanelEntry.online`
    - `PanelStatus`
      - `PanelStatus.accessory_release`
      - `PanelStatus.accessory_type`
      - `PanelStatus.actuators`
      - `PanelStatus.all_endpoints`
      - `PanelStatus.areas`
      - `PanelStatus.cover_feature`
      - `PanelStatus.covers`
      - `PanelStatus.from_api_response()`
      - `PanelStatus.groups`
      - `PanelStatus.panel_id`
      - `PanelStatus.push_feature`
      - `PanelStatus.release`
      - `PanelStatus.scene_feature`
      - `PanelStatus.scenes`
      - `PanelStatus.user_email`
      - `PanelStatus.zones`
  - elmax_api.model.scene module
    - `Scene`
      - `Scene.from_api_response()`
  - elmax_api.model.zone module
    - `Zone`
      - `Zone.excluded`
      - `Zone.from_api_response()`
      - `Zone.opened`
  - Module contents

## Submodules

## elmax_api.constants module

Constants for the Elmax Cloud service client.

## elmax_api.exceptions module

Exceptions for the Elmax Cloud services client.

exception elmax_api.exceptions.ElmaxApiError(status_code: int)

  Bases: `Exception`

  Occurs when an API returns an unexpected return code

  property status_code

exception elmax_api.exceptions.ElmaxBadLoginError

  Bases: `ElmaxError`

  Occurs when a login attempt fails

exception elmax_api.exceptions.ElmaxBadPinError

  Bases: `ElmaxError`

  Occurs when a BAD pin is used with the discovery api

exception elmax_api.exceptions.ElmaxError

  Bases: `Exception`

  General ElmaxError exception occurred.

exception elmax_api.exceptions.ElmaxNetworkError

  Bases: `ElmaxError`

  When a network error is encountered.

exception elmax_api.exceptions.ElmaxPanelBusyError

  Bases: `ElmaxError`

  Occurs when a command cannot be executed due to panel busy status

## elmax_api.http module

## Module contents

Client for the Elmax Cloud services.