Response models

DataGatewayNetworkResponseModel

Bases: NamedTuple

Gateway

Parameters:

Name	Type	Description	Default
network		NetworkResponseModel	required
protocol		ProtokolResponseModel	required
mac	int	unique identifier of the device in the network	required

Source code in unicboard_billing_sdk/response_models.py

class DataGatewayNetworkResponseModel(NamedTuple):
    """
    Gateway

    Parameters:
        network: [NetworkResponseModel](NetworkResponseModel.md)
        protocol: [ProtokolResponseModel](ProtokolResponseModel.md)
        mac (int): unique identifier of the device in the network
    """
    network: NetworkResponseModel
    protocol: ProtokolResponseModel
    mac: int

DataGatewayResponseModel

Bases: NamedTuple

Gateway

Parameters:

Name	Type	Description	Default
name	str	name of input system	required

Source code in unicboard_billing_sdk/response_models.py

class DataGatewayResponseModel(NamedTuple):
    """
    Gateway

    Parameters:
        name (str): name of input system
    """
    name: str

DeviceChannelResponseModel

Bases: NamedTuple

Device channel information

Parameters:

Name	Type	Description	Default
inactivity_limit	int	idle time to create a non-arrival data event (second)	required
last_date_event_no_data	datetime	last date of non-arrival event	required
serial_number	int	channel serial number (1,2,3,4,5)	required

Source code in unicboard_billing_sdk/response_models.py

class DeviceChannelResponseModel(NamedTuple):
    """
    Device channel information

    Parameters:
        inactivity_limit (int): idle time to create a non-arrival data event (second)
        last_date_event_no_data (datetime): last date of non-arrival event
        serial_number (int): channel serial number (1,2,3,4,5)
    """
    inactivity_limit: int
    last_date_event_no_data: Optional[datetime]
    serial_number: int
    device_meters: List[DeviceMeterResponseModel]

DeviceManufacturerResponseModel

Bases: NamedTuple

The manufacturer's name

Parameters:

Name	Type	Description	Default
name	str	manufacturer's name	required

Source code in unicboard_billing_sdk/response_models.py

class DeviceManufacturerResponseModel(NamedTuple):
    """
    The manufacturer's name

    Parameters:
        name (str): manufacturer's name
    """
    name: str

DeviceMeterResponseModel

Bases: NamedTuple

Device meter information

Parameters:

Name	Type	Description	Default
last_value	float	last counter value (cubic meter(m3))	required
last_value_date	datetime	date of last receipt of readings (datetime)	required
unit_multiplier	float	recalculates measurements (between database and user)	required
value_multiplier	float	recalculates measurements (between meter and database)	required

Source code in unicboard_billing_sdk/response_models.py

class DeviceMeterResponseModel(NamedTuple):
    """
    Device meter information

    Parameters:
        last_value (float): last counter value (cubic meter(m3))
        last_value_date (datetime): date of last receipt of readings (datetime)
        unit_multiplier (float): recalculates measurements (between database and user)
        value_multiplier (float): recalculates measurements (between meter and database)
    """
    last_value: Optional[float]
    last_value_date: Optional[datetime]
    unit_multiplier: float
    value_multiplier: float

DeviceMeteringType

Bases: NamedTuple

Type of measuring system (gas, water)

Parameters:

Name	Type	Description	Default
name_ru	str	name of the measuring system in Russian/English (for the user)	required
name_en	str	name of the measuring system in Russian/English (for the user)	required
sys_name	str	name of the measuring system in the system (code)	required

Source code in unicboard_billing_sdk/response_models.py

class DeviceMeteringType(NamedTuple):
    """
    Type of measuring system (gas, water)

    Parameters:
        name_ru (str): name of the measuring system in Russian/English (for the user)
        name_en (str): name of the measuring system in Russian/English (for the user)
        sys_name (str): name of the measuring system in the system (code)
    """
    name_en: str
    name_ru: str
    sys_name: str

DeviceModificationResponseModel

Bases: NamedTuple

Device modification

Parameters:

Name	Type	Description	Default
device_modification_type		DeviceModificationTypeResponseModel	required
name	str	device modification's name	required

Source code in unicboard_billing_sdk/response_models.py

class DeviceModificationResponseModel(NamedTuple):
    """
    Device modification

    Parameters:
        device_modification_type: [DeviceModificationTypeResponseModel](DeviceModificationTypeResponseModel.md)
        name (str): device modification's name
    """
    device_modification_type: DeviceModificationTypeResponseModel
    name: str

DeviceModificationTypeResponseModel

Bases: NamedTuple

Device model

Parameters:

Name	Type	Description	Default
device_metering_type		DeviceMeteringType	required
name_ru_en	str	name of the device model in Russian/English (for the user)	required
sys_name	str	name of the device model in the system (code)	required
type	str	smart_meter/modem	required

Source code in unicboard_billing_sdk/response_models.py

class DeviceModificationTypeResponseModel(NamedTuple):
    """
    Device model

    Parameters:
        device_metering_type: [DeviceMeteringType](DeviceMeteringType.md)
        name_ru_en (str): name of the device model in Russian/English (for the user)
        sys_name (str): name of the device model in the system (code)
        type (str): smart_meter/modem
    """
    device_metering_type: DeviceMeteringType
    name_en: str
    name_ru: str
    sys_name: str
    type: str

GetDeviceBatteryLevelResponse

Bases: NamedTuple

Device battery level list

Parameters:

Name	Type	Description	Default
count	int	object's limit count	required
errors	any	presence of errors	required
ok	bool	validity	required
total_count	int	object's total count	required
payload	list	GetDeviceListBatteryLevelPayloadResponse	required

Source code in unicboard_billing_sdk/response_models.py

class GetDeviceBatteryLevelResponse(NamedTuple):
    """
    Device battery level list

    Parameters:
        count (int): object's limit count
        errors (any): presence of errors
        ok (bool): validity
        total_count (int): object's total count
        payload (list): [GetDeviceListBatteryLevelPayloadResponse](GetDeviceListBatteryLevelPayloadResponse.md)
    """
    count: int
    errors: List[Any]
    ok: bool
    total_count: int
    payload: List[GetDeviceListBatteryLevelPayloadResponse]

GetDeviceChannelValuePayloadResponse

Bases: NamedTuple

Device channel values

Parameters:

Name	Type	Description	Default
channel_number	int	channel number	required
date	datetime	date and time of receipt	required
date_created	datetime	date and time the entry was created	required
device_id	UUID	unique device identifier in the system	required
value	float	product of value_raw and value_multiplier (recalculated values)	required
value_raw	float	initial value	required
value_type	str	device_data(meter reading), interpolated_linear(interpolated reading)	required
meter_id	str	meter identifier	required
last	value Optional(float	last value	required
last_value_date	Optional(datetime	last value date	required

Source code in unicboard_billing_sdk/response_models.py

class GetDeviceChannelValuePayloadResponse(NamedTuple):
    """
    Device channel values

    Parameters:
        channel_number (int): channel number
        date (datetime): date and time of receipt
        date_created (datetime): date and time the entry was created
        device_id (UUID): unique device identifier in the system
        value (float): product of value_raw and value_multiplier (recalculated values)
        value_raw (float): initial value
        value_type (str): device_data(meter reading), interpolated_linear(interpolated reading)
        meter_id (str): meter identifier
        last value Optional(float): last value
        last_value_date Optional(datetime): last value date
    """
    channel_number: int
    date: datetime
    date_created: datetime
    device_id: UUID
    value: Optional[float]
    value_raw: Optional[float]
    value_type: str
    kind: str
    tariff_number: int
    journal_data_type: Dict[str, Any]
    meter_id: UUID
    last_value: Optional[float]
    last_value_date: Optional[datetime]

GetDeviceClockResponse

Bases: NamedTuple

Device clock info list

Parameters:

Name	Type	Description	Default
count	int	object's limit count	required
errors	any	presence of errors	required
ok	bool	validity	required
total_count	int	object's total count	required
payload	list	GetDeviceListClockPayloadResponse	required

Source code in unicboard_billing_sdk/response_models.py

class GetDeviceClockResponse(NamedTuple):
    """
    Device clock info list

    Parameters:
        count (int): object's limit count
        errors (any): presence of errors
        ok (bool): validity
        total_count (int): object's total count
        payload (list): [GetDeviceListClockPayloadResponse](GetDeviceListClockPayloadResponse.md)
    """
    count: int
    errors: List[Any]
    ok: bool
    total_count: int
    payload: List[GetDeviceListClockPayloadResponse]

GetDeviceEventResponse

Bases: NamedTuple

Device events list

Parameters:

Name	Type	Description	Default
count	int	object's limit count	required
errors	any	presence of errors	required
ok	bool	validity	required
total_count	int	object's total count	required
payload	list	GetDeviceListEventPayloadResponse	required

Source code in unicboard_billing_sdk/response_models.py

class GetDeviceEventResponse(NamedTuple):
    """
    Device events list

    Parameters:
        count (int): object's limit count
        errors (any): presence of errors
        ok (bool): validity
        total_count (int): object's total count
        payload (list): [GetDeviceListEventPayloadResponse](GetDeviceListEventPayloadResponse.md)
    """
    count: int
    errors: List[Any]
    ok: bool
    total_count: int
    payload: List[GetDeviceListEventPayloadResponse]

GetDeviceInfoResponse

Bases: NamedTuple

Device information list

Parameters:

Name	Type	Description	Default
errors	any	presence of errors	required
ok	bool	successful request	required
payload		GetDeviceListInfoPayloadResponse	required

Source code in unicboard_billing_sdk/response_models.py

class GetDeviceInfoResponse(NamedTuple):
    """
    Device information list

    Parameters:
        errors (any): presence of errors
        ok (bool): successful request
        payload: [GetDeviceListInfoPayloadResponse](GetDeviceListInfoPayloadResponse.md)
    """
    errors: List[Any]
    ok: bool
    payload: GetDeviceListInfoPayloadResponse

GetDeviceListBatteryLevelPayloadResponse

Bases: NamedTuple

Device battery level values

Parameters:

Name	Type	Description	Default
device_id	UUID	device system identifier	required
battery_id	UUID	identifier of device battery	required
date	datetime	date of value	required
value	float	value of battery level	required

Source code in unicboard_billing_sdk/response_models.py

class GetDeviceListBatteryLevelPayloadResponse(NamedTuple):
    """
    Device battery level values

    Parameters:
        device_id (UUID): device system identifier
        battery_id (UUID): identifier of device battery
        date (datetime): date of value
        value (float): value of battery level
    """
    device_id: UUID
    battery_id: int
    date: datetime
    value: Optional[float]

GetDeviceListClockPayloadResponse

Bases: NamedTuple

Device clock info

Parameters:

Name	Type	Description	Default
device_id	UUID	device system identifier	required
clock_id	int	device clock identifier	required
device_clock	datetime	time on the device linked to a specific device clock	required
date	datetime	date of receipt data	required
device_tz	str	device time zone	required
tz_offset_s	int	difference between server and device timezone	required
out_of_sync_s	float	time difference of the clock in seconds from the current time	required
out_of_sync_type	str	discrepancy type: 'synced' - less than 5 seconds 'out_of_sync_warning' - less than 10 seconds 'out_of_sync_critical' - less than or equal to 15 seconds 'unsynchronized' - more than 15 seconds	required

Source code in unicboard_billing_sdk/response_models.py

class GetDeviceListClockPayloadResponse(NamedTuple):
    """
    Device clock info

    Parameters:
        device_id (UUID): device system identifier
        clock_id (int): device clock identifier
        device_clock (datetime): time on the device linked to a specific device clock
        date (datetime): date of receipt data
        device_tz (str): device time zone
        tz_offset_s (int): difference between server and device timezone
        out_of_sync_s (float): time difference of the clock in seconds from the current time
        out_of_sync_type (str): discrepancy type:
            'synced' - less than 5 seconds
            'out_of_sync_warning' - less than 10 seconds
            'out_of_sync_critical' - less than or equal to 15 seconds
            'unsynchronized' - more than 15 seconds
    """
    device_id: UUID
    clock_id: int
    device_clock: datetime
    date: datetime
    device_tz: str
    tz_offset_s: int
    out_of_sync_s: float
    out_of_sync_type: str

GetDeviceListEventPayloadResponse

Bases: NamedTuple

Device events

Parameters:

Name	Type	Description	Default
device_id	UUID	device system identifier	required
type	str	type of event	required
date	datetime	date of event	required
value	float	value of event	required
data	json	additional data of event	required

Source code in unicboard_billing_sdk/response_models.py

class GetDeviceListEventPayloadResponse(NamedTuple):
    """
    Device events

    Parameters:
        device_id (UUID): device system identifier
        type (str): type of event
        date (datetime): date of event
        value (float): value of event
        data (json): additional data of event
    """
    device_id: UUID
    type: str
    date: datetime
    value: Optional[float]
    data: Optional[Dict[str, Any]]

GetDeviceListInfoPayloadResponse

Bases: NamedTuple

Device information

Parameters:

Name	Type	Description	Default
data_gateway_network_device		DataGatewayNetworkResponseModel	required
device_channel	list	DeviceChannelResponseModel	required
device_manufacturer		DeviceManufacturerResponseModel	required
device_modification		DeviceModificationResponseModel	required
date_produced	datetime	date of manufacture of the device	required
firmware_version	str	software version	required
hardware_version	str	hardware version	required
id	UUID	system identifier	required
manufacturer_serial_number	str	manufacturer-serial number	required

Source code in unicboard_billing_sdk/response_models.py

class GetDeviceListInfoPayloadResponse(NamedTuple):
    """
    Device information

    Parameters:
        data_gateway_network_device: [DataGatewayNetworkResponseModel](DataGatewayNetworkResponseModel.md)
        device_channel (list): [DeviceChannelResponseModel](DeviceChannelResponseModel.md)
        device_manufacturer: [DeviceManufacturerResponseModel](DeviceManufacturerResponseModel.md)
        device_modification: [DeviceModificationResponseModel](DeviceModificationResponseModel.md)
        date_produced (datetime): date of manufacture of the device
        firmware_version (str): software version
        hardware_version (str): hardware version
        id (UUID): system identifier
        manufacturer_serial_number (str): manufacturer-serial number
    """
    data_gateway_network_device: DataGatewayNetworkResponseModel
    device_channel: List[DeviceChannelResponseModel]
    device_manufacturer: DeviceManufacturerResponseModel
    device_modification: DeviceModificationResponseModel
    date_produced: Optional[datetime]
    firmware_version: Optional[str]
    hardware_version: Optional[str]
    id: UUID
    manufacturer_serial_number: str

GetDeviceListInfoResponse

Bases: NamedTuple

Device information list

Parameters:

Name	Type	Description	Default
count	int	object's limit count	required
errors	any	presence of errors	required
ok	bool	validity	required
total_count	int	object's total count	required
payload	list	GetDeviceListInfoPayloadResponse	required

Source code in unicboard_billing_sdk/response_models.py

class GetDeviceListInfoResponse(NamedTuple):
    """
    Device information list

    Parameters:
        count (int): object's limit count
        errors (any): presence of errors
        ok (bool): validity
        total_count (int): object's total count
        payload (list): [GetDeviceListInfoPayloadResponse](GetDeviceListInfoPayloadResponse.md)
    """
    count: int
    errors: List[Any]
    ok: bool
    total_count: int
    payload: List[GetDeviceListInfoPayloadResponse]

GetDeviceListProfilePayloadResponse

Bases: NamedTuple

Device events

Parameters:

Name	Type	Description	Default
device_id	UUID	device system identifier	required
date_start	datetime	date and time profile start	required
date_end	str	date and time profile end	required
profile_kind	float	kind of profile	required
granularity_s		the time for which each value in field "values" is responsible, from 1 second to 60 minutes	required
values_count	int	count values in field "values" (date_start - date_end = granularity_s * values_count)	required
values	list of floats	list of profile values	required

Source code in unicboard_billing_sdk/response_models.py

class GetDeviceListProfilePayloadResponse(NamedTuple):
    """
    Device events

    Parameters:
        device_id (UUID): device system identifier
        date_start (datetime): date and time profile start
        date_end (str): date and time profile end
        profile_kind (float): kind of profile
        granularity_s: the time for which each value in field "values" is responsible, from 1 second to 60 minutes
        values_count (int): count values in field "values" (date_start - date_end = granularity_s * values_count)
        values (list of floats): list of profile values
    """
    device_id: UUID
    date_start: datetime
    date_end: datetime
    profile_kind: str
    granularity_s: str
    values_count: int
    values: List[float]

GetDeviceListTemperaturePayloadResponse

Bases: NamedTuple

Device temperature values

Parameters:

Name	Type	Description	Default
device_id	UUID	device system identifier	required
date	datetime	date of value	required
value	float	value of temperature	required

Source code in unicboard_billing_sdk/response_models.py

class GetDeviceListTemperaturePayloadResponse(NamedTuple):
    """
    Device temperature values

    Parameters:
        device_id (UUID): device system identifier
        date (datetime): date of value
        value (float): value of temperature
    """
    device_id: UUID
    date: datetime
    value: Optional[float]

GetDeviceListUptimePayloadResponse

Bases: NamedTuple

Device temperature values

Parameters:

Name	Type	Description	Default
device_id	UUID	device system identifier	required
channel_id	UUID	device channel system identifier	required
channel_serial_number	int	channel serial number (1,2,3,4,5)	required
date	datetime	value of date	required
value	float	value of uptime	required

Source code in unicboard_billing_sdk/response_models.py

class GetDeviceListUptimePayloadResponse(NamedTuple):
    """
    Device temperature values

    Parameters:
        device_id (UUID): device system identifier
        channel_id (UUID): device channel system identifier
        channel_serial_number (int): channel serial number (1,2,3,4,5)
        date (datetime): value of date
        value (float): value of uptime
    """
    device_id: UUID
    channel_id: UUID
    channel_serial_number: int
    date: datetime
    uptime_s: float

GetDeviceProfileResponse

Bases: NamedTuple

Device profile list

Parameters:

Name	Type	Description	Default
count	int	object's limit count	required
errors	any	presence of errors	required
ok	bool	validity	required
total_count	int	object's total count	required
payload	list	GetDeviceProfileResponse	required

Source code in unicboard_billing_sdk/response_models.py

class GetDeviceProfileResponse(NamedTuple):
    """
    Device profile list

    Parameters:
        count (int): object's limit count
        errors (any): presence of errors
        ok (bool): validity
        total_count (int): object's total count
        payload (list): [GetDeviceProfileResponse](GetDeviceProfileResponse.md)
    """
    count: int
    errors: List[Any]
    ok: bool
    total_count: int
    payload: List[GetDeviceListProfilePayloadResponse]

GetDeviceTemperatureResponse

Bases: NamedTuple

Device temperature info list

Parameters:

Name	Type	Description	Default
count	int	object's limit count	required
errors	any	presence of errors	required
ok	bool	validity	required
total_count	int	object's total count	required
payload	list	GetDeviceListTemperaturePayloadResponse	required

Source code in unicboard_billing_sdk/response_models.py

class GetDeviceTemperatureResponse(NamedTuple):
    """
    Device temperature info list

    Parameters:
        count (int): object's limit count
        errors (any): presence of errors
        ok (bool): validity
        total_count (int): object's total count
        payload (list): [GetDeviceListTemperaturePayloadResponse](GetDeviceListTemperaturePayloadResponse.md)
    """
    count: int
    errors: List[Any]
    ok: bool
    total_count: int
    payload: List[GetDeviceListTemperaturePayloadResponse]

GetDeviceUptimeResponse

Bases: NamedTuple

Device temperature info list

Parameters:

Name	Type	Description	Default
count	int	object's limit count	required
errors	any	presence of errors	required
ok	bool	validity	required
total_count	int	object's total count	required
payload	list	GetDeviceListUptimePayloadResponse	required

Source code in unicboard_billing_sdk/response_models.py

class GetDeviceUptimeResponse(NamedTuple):
    """
    Device temperature info list

    Parameters:
        count (int): object's limit count
        errors (any): presence of errors
        ok (bool): validity
        total_count (int): object's total count
        payload (list): [GetDeviceListUptimePayloadResponse](GetDeviceListUptimePayloadResponse.md)
    """
    count: int
    errors: List[Any]
    ok: bool
    total_count: int
    payload: List[GetDeviceListUptimePayloadResponse]

GetDeviceValueResponse

Bases: NamedTuple

Device channel information list

Parameters:

Name	Type	Description	Default
count	int	object's limit count	required
errors	any	presence of errors	required
ok	bool	validity	required
total_count	int	object's total count	required
payload	list	GetDeviceChannelValuePayloadResponse	required

Source code in unicboard_billing_sdk/response_models.py

class GetDeviceValueResponse(NamedTuple):
    """
    Device channel information list

   Parameters:
        count (int): object's limit count
        errors (any): presence of errors
        ok (bool): validity
        total_count (int): object's total count
        payload (list): [GetDeviceChannelValuePayloadResponse](GetDeviceChannelValuePayloadResponse.md)
    """
    count: int
    errors: List[Any]
    ok: bool
    total_count: int
    payload: List[GetDeviceChannelValuePayloadResponse]

NetworkResponseModel

Bases: NamedTuple

Internal network

Parameters:

Name	Type	Description	Default
data_gateway		DataGatewayResponseModel	required
name	str	network's name	required
type_network	str	type of network, can be output or input	required

Source code in unicboard_billing_sdk/response_models.py

class NetworkResponseModel(NamedTuple):
    """
    Internal network

    Parameters:
        data_gateway: [DataGatewayResponseModel](DataGatewayResponseModel.md)
        name (str): network's name
        type_network (str): type of network, can be output or input
    """
    data_gateway: DataGatewayResponseModel
    name: str
    type_network: str

ProtokolResponseModel

Bases: NamedTuple

Protocol's name

Parameters:

Name	Type	Description	Default
name	str	protocol's name	required

Source code in unicboard_billing_sdk/response_models.py

class ProtokolResponseModel(NamedTuple):
    """
    Protocol's name

    Parameters:
        name (str): protocol's name
    """
    name: str