Data Models¶

Data models for Akuvox API responses.

class pylocal_akuvox.models.DeviceInfo[source]¶

Bases: object

Read-only device identification data.

model: str¶

mac_address: str¶

firmware_version: str¶

hardware_version: str¶

uptime: str | None = None¶

web_language: int | None = None¶

classmethod from_api_response(data)[source]¶

Create DeviceInfo from API response data.

Return type:: DeviceInfo
Parameters:: data (dict[str, Any])

__init__(model, mac_address, firmware_version, hardware_version, uptime=None, web_language=None)¶

Parameters:

model (str)
mac_address (str)
firmware_version (str)
hardware_version (str)
uptime (str | None)
web_language (int | None)

Return type:

None

class pylocal_akuvox.models.DeviceStatus[source]¶

Bases: object

Point-in-time device operational status.

unix_time: int¶

uptime: int¶

classmethod from_api_response(data)[source]¶

Create DeviceStatus from API response data.

Return type:: DeviceStatus
Parameters:: data (dict[str, Any])

__init__(unix_time, uptime)¶

Parameters:

unix_time (int)
uptime (int)

Return type:

None

class pylocal_akuvox.models.Relay[source]¶

Bases: object

Controllable relay on the device.

number: int¶

state: str | None = None¶

classmethod from_api_response(data)[source]¶

Create Relay from API response data.

Return type:: Relay
Parameters:: data (dict[str, Any])

__init__(number, state=None)¶

Parameters:

number (int)
state (str | None)

Return type:

None

class pylocal_akuvox.models.User[source]¶

Bases: object

Local user account stored on the device.

name: str¶

user_id: str¶

schedule_relay: str¶

id: str | None = None¶

web_relay: str | None = None¶

private_pin: str | None = None¶

card_code: str | None = None¶

lift_floor_num: str | None = None¶

user_type: str | None = None¶

source: str | None = None¶

source_type: str | None = None¶

classmethod from_api_response(data)[source]¶

Create User from API response data.

Return type:: User
Parameters:: data (dict[str, Any])

to_api_payload()[source]¶

Convert to PascalCase dict for add/set API calls.

Return type:: dict[str, str]

__init__(*, name, user_id, schedule_relay, id=None, web_relay=None, private_pin=None, card_code=None, lift_floor_num=None, user_type=None, source=None, source_type=None)¶

Parameters:

name (str)
user_id (str)
schedule_relay (str)
id (str | None)
web_relay (str | None)
private_pin (str | None)
card_code (str | None)
lift_floor_num (str | None)
user_type (str | None)
source (str | None)
source_type (str | None)

Return type:

None

class pylocal_akuvox.models.AccessSchedule[source]¶

Bases: object

Time-based access schedule stored on the device.

schedule_type: str¶

id: str | None = None¶

name: str | None = None¶

date_start: str | None = None¶

date_end: str | None = None¶

time_start: str | None = None¶

time_end: str | None = None¶

week: str | None = None¶

daily: str | None = None¶

display_id: str | None = None¶

source_type: str | None = None¶

mode: str | None = None¶

sun: str | None = None¶

mon: str | None = None¶

tue: str | None = None¶

wed: str | None = None¶

thur: str | None = None¶

fri: str | None = None¶

sat: str | None = None¶

classmethod from_api_response(data)[source]¶

Create AccessSchedule from API response data.

Return type:: AccessSchedule
Parameters:: data (dict[str, Any])

to_api_payload()[source]¶

Convert to PascalCase dict for add/set API calls.

Return type:: dict[str, str]

__init__(*, schedule_type, id=None, name=None, date_start=None, date_end=None, time_start=None, time_end=None, week=None, daily=None, display_id=None, source_type=None, mode=None, sun=None, mon=None, tue=None, wed=None, thur=None, fri=None, sat=None)¶

Parameters:

schedule_type (str)
id (str | None)
name (str | None)
date_start (str | None)
date_end (str | None)
time_start (str | None)
time_end (str | None)
week (str | None)
daily (str | None)
display_id (str | None)
source_type (str | None)
mode (str | None)
sun (str | None)
mon (str | None)
tue (str | None)
wed (str | None)
thur (str | None)
fri (str | None)
sat (str | None)

Return type:

None

class pylocal_akuvox.models.DoorLogEntry[source]¶

Bases: object

Read-only record from the device door access log.

id: str¶

date: str¶

time: str¶

name: str¶

code: str¶

door_type: str¶

status: str¶

relay: str | None = None¶

access_mode: str | None = None¶

classmethod from_api_response(data)[source]¶

Create DoorLogEntry from API response data.

Return type:: DoorLogEntry
Parameters:: data (dict[str, Any])

__init__(*, id, date, time, name, code, door_type, status, relay=None, access_mode=None)¶

Parameters:

id (str)
date (str)
time (str)
name (str)
code (str)
door_type (str)
status (str)
relay (str | None)
access_mode (str | None)

Return type:

None

class pylocal_akuvox.models.CallLogEntry[source]¶

Bases: object

Read-only record from the device call log.

id: str¶

date: str¶

time: str¶

name: str¶

call_type: str¶

local_identity: str¶

count: str¶

pic_url: str | None = None¶

classmethod from_api_response(data)[source]¶

Create CallLogEntry from API response data.

Return type:: CallLogEntry
Parameters:: data (dict[str, Any])

__init__(*, id, date, time, name, call_type, local_identity, count, pic_url=None)¶

Parameters:

id (str)
date (str)
time (str)
name (str)
call_type (str)
local_identity (str)
count (str)
pic_url (str | None)

Return type:

None

class pylocal_akuvox.models.DeviceConfig[source]¶

Bases: object

Full device configuration from /api/config/get.

Wraps all autop-format key-value pairs returned by the device. Provides dict-like read access to any configuration key.

data: dict[str, str]¶

classmethod from_api_response(data)[source]¶

Create DeviceConfig from API response data.

Return type:: DeviceConfig
Parameters:: data (dict[str, Any])

to_api_payload()[source]¶

Return the full data dict for set API calls.

Return type:: dict[str, str]

keys()[source]¶

Return all autop-format key names in this config.

Return type:: list[str]

Returns:: List of dotted key strings (e.g., Config.DoorSetting.RELAY.HoldDelayA).

get(key, default=None)[source]¶

Get a config value by autop-format key.

Return type:

str | None

Parameters:

key (str)
default (str | None)

__init__(*, data)¶

Parameters:: data (dict[str, str])
Return type:: None

class pylocal_akuvox.models.Group[source]¶

Bases: object

Organizational group stored on the device.

name: str¶

id: str | None = None¶

classmethod from_api_response(data)[source]¶

Create Group from API response data.

Return type:: Group
Parameters:: data (dict[str, Any])

to_api_payload()[source]¶

Convert to PascalCase dict for add/set API calls.

Return type:: dict[str, str]

__init__(*, name, id=None)¶

Parameters:

name (str)
id (str | None)

Return type:

None

class pylocal_akuvox.models.Contact[source]¶

Bases: object

Contact entry in the device address book.

name: str¶

id: str | None = None¶

phone: str | None = None¶

group: str | None = None¶

classmethod from_api_response(data)[source]¶

Create Contact from API response data.

Return type:: Contact
Parameters:: data (dict[str, Any])

to_api_payload()[source]¶

Convert to PascalCase dict for add/set API calls.

Return type:: dict[str, str]

__init__(*, name, id=None, phone=None, group=None)¶

Parameters:

name (str)
id (str | None)
phone (str | None)
group (str | None)

Return type:

None