pyControl4 API documentation

# Package `pyControl4`

## Sub-modules

`pyControl4.account`

  Authenticates with the Control4 API, retrieves account and registered controller info, and retrieves a bearer token for connecting to a Control4 …

`pyControl4.alarm`

  Controls Control4 security panel and contact sensor (door, window, motion) devices.

`pyControl4.blind`

  Controls Control4 blind devices.

`pyControl4.climate`

  Controls Control4 Climate Control devices.

`pyControl4.director`

  Handles communication with a Control4 Director, and provides functions for getting details about items on the Director.

`pyControl4.error_handling`

  Handles errors received from the Control4 API.

`pyControl4.fan`

  Controls Control4 Fan devices.

`pyControl4.light`

  Controls Control4 Light devices.

`pyControl4.relay`

  Controls Control4 Relay devices. These can include locks, and potentially other types of devices.

`pyControl4.room`

  Controls Control4 Room devices.

`pyControl4.websocket`

  Handles Websocket connections to a Control4 Director, allowing for real-time updates using callbacks.

## Classes

`class C4Entity (director: C4Director, item_id: int)`
  Expand source code

      class C4Entity:
          def __init__(self, director: C4Director, item_id: int):
              """Creates a Control4 object.

              Parameters:
                  `director` - A `pyControl4.director.C4Director` object that corresponds
                      to the Control4 Director that the device is connected to.

                  `item_id` - The Control4 item ID.
              """
              self.director = director
              self.item_id = int(item_id)

  Creates a Control4 object.

  ## Parameters

  `pyControl4.director` - A `C4Director` object that corresponds to the Control4 Director that the device is connected to.

  `item_id` - The Control4 item ID.

  ### Subclasses

  - C4SecurityPanel
  - C4Blind
  - C4Climate
  - C4Fan
  - C4Light
  - C4Relay
  - C4Room