Skip to content

Device models

Request and response types for the Device API.

models

Classes:

ActivationType

Bases: str, Enum

Attributes:

ABP class-attribute instance-attribute

ABP = 'ABP'

OTAA class-attribute instance-attribute

OTAA = 'OTAA'

CreateDevicesResponse

Bases: BaseModelWithConfig

Attributes:

deveui instance-attribute

deveui: str

error instance-attribute

error: str

id instance-attribute

id: str

response instance-attribute

response: bool

DeleteDevicesResponse

Bases: BaseModelWithConfig

Attributes:

deveui instance-attribute

deveui: str

error instance-attribute

error: str

response instance-attribute

response: bool

DeviceConfigInfo

Bases: BaseModelWithConfig

Attributes:

activation_type instance-attribute

activation_type: str

application_s_key instance-attribute

application_s_key: str

decoder_type instance-attribute

decoder_type: str

dev_addr instance-attribute

dev_addr: str

deveui instance-attribute

deveui: str

name instance-attribute

name: str

network_server_type instance-attribute

network_server_type: str

output_profile instance-attribute

output_profile: OutputProfileInstance

private_data instance-attribute

private_data: bool

subscriber_id instance-attribute

subscriber_id: str

DeviceCreate

Bases: BaseModelWithConfig

Attributes:

activation_type instance-attribute

activation_type: ActivationType

application_eui class-attribute instance-attribute

application_eui: str | None = None

application_key class-attribute instance-attribute

application_key: str | None = None

application_s_key class-attribute instance-attribute

application_s_key: str | None = None

decoder_type class-attribute instance-attribute

decoder_type: str | None = None

dev_addr class-attribute instance-attribute

dev_addr: str | None = None

deveui instance-attribute

deveui: str

device_profile instance-attribute

device_profile: str

name instance-attribute

name: str

network_s_key class-attribute instance-attribute

network_s_key: str | None = None

network_skey class-attribute instance-attribute

network_skey: str | None = None

output_profile class-attribute instance-attribute

output_profile: str | None = None

private_data class-attribute instance-attribute

private_data: bool = False

service_profile instance-attribute

service_profile: str

DeviceCreateResponse

Bases: BaseModelWithConfig

Attributes:

id instance-attribute

id: str

DeviceError

Bases: BaseModelWithConfig

Attributes:

response instance-attribute

response: bool

DeviceFilter

Bases: BaseModelWithConfig

Attributes:

deveui instance-attribute

deveui: str

DeviceInstance

Bases: BaseModelWithConfig

Attributes:

activation_type instance-attribute

activation_type: str

created_at instance-attribute

created_at: datetime

decoder_type instance-attribute

decoder_type: str

deveui instance-attribute

deveui: str

device_profile instance-attribute

device_profile: str
last_uplink: datetime | None

name instance-attribute

name: str

output_profile instance-attribute

output_profile: str

payload_decoder instance-attribute

payload_decoder: PayloadDecoderType

private_data instance-attribute

private_data: bool

service_profile instance-attribute

service_profile: str

statistics instance-attribute

statistics: DeviceStatistics

updated_at instance-attribute

updated_at: datetime

updated_by instance-attribute

updated_by: str

DeviceMessage

Bases: BaseModelWithConfig

Methods:

Attributes:

application_payload class-attribute instance-attribute

application_payload: dict[str, Any] | None = None

confirm class-attribute instance-attribute

confirm: bool = False

flush_queue class-attribute instance-attribute

flush_queue: bool = False

payload instance-attribute

payload: str | None

target_port instance-attribute

target_port: int | None

int_to_str

int_to_str(value: int) -> str

DevicePatch

Bases: BaseModelWithConfig

Attributes:

decoder_type class-attribute instance-attribute

decoder_type: str | None = None

device_profile class-attribute instance-attribute

device_profile: str | None = None

name class-attribute instance-attribute

name: str | None = None

output_profile class-attribute instance-attribute

output_profile: str | None = None

private_data class-attribute instance-attribute

private_data: bool | None = None

remove_output_profile class-attribute instance-attribute

remove_output_profile: bool | None = None

service_profile class-attribute instance-attribute

service_profile: str | None = None

DevicePayload

Bases: BaseModelWithConfig

Attributes:

application_data instance-attribute

application_data: dict[str, Any]

data instance-attribute

data: dict[str, Any]

time instance-attribute

time: datetime

DevicePayloadResponse

Bases: BaseModelWithConfig

Attributes:

payloads instance-attribute

payloads: list[DevicePayload]

DeviceResponse

Bases: BaseModelWithConfig

Attributes:

devices instance-attribute

devices: list[DeviceInstance]

DeviceStatistics

Bases: BaseModelWithConfig

Attributes:

average_esp instance-attribute

average_esp: float

average_rssi instance-attribute

average_rssi: float

average_snr instance-attribute

average_snr: float

average_weekly_packets instance-attribute

average_weekly_packets: int

battery_level instance-attribute

battery_level: int

health_state instance-attribute

health_state: str

packet_error_rate instance-attribute

packet_error_rate: float

spreading_factor instance-attribute

spreading_factor: int

DeviceUpdate

Bases: BaseModelWithConfig

Attributes:

decoder_type instance-attribute

decoder_type: str | None

device_profile instance-attribute

device_profile: str

name instance-attribute

name: str

output_profile instance-attribute

output_profile: str | None

private_data instance-attribute

private_data: bool | None

service_profile instance-attribute

service_profile: str

DevicesHealthCountResponse

Bases: BaseModelWithConfig

Attributes:

fair instance-attribute

fair: int

good instance-attribute

good: int

offline instance-attribute

offline: int

poor instance-attribute

poor: int

DevicesHealthResponse

Bases: BaseModelWithConfig

Attributes:

fair instance-attribute

good instance-attribute

offline instance-attribute

offline: list[DeviceInstance]

poor instance-attribute