Device models
Request and response types for the Device API.
models
Classes:
-
ActivationType– -
CreateDevicesResponse– -
DeleteDevicesResponse– -
DeviceConfigInfo– -
DeviceCreate– -
DeviceCreateResponse– -
DeviceError– -
DeviceFilter– -
DeviceInstance– -
DeviceMessage– -
DevicePatch– -
DevicePayload– -
DevicePayloadResponse– -
DeviceResponse– -
DeviceStatistics– -
DeviceUpdate– -
DevicesHealthCountResponse– -
DevicesHealthResponse–
ActivationType
CreateDevicesResponse
DeleteDevicesResponse
DeviceConfigInfo
Bases: BaseModelWithConfig
Attributes:
-
activation_type(str) – -
application_s_key(str) – -
decoder_type(str) – -
dev_addr(str) – -
deveui(str) – -
name(str) – -
network_server_type(str) – -
output_profile(OutputProfileInstance) – -
private_data(bool) – -
subscriber_id(str) –
DeviceCreate
Bases: BaseModelWithConfig
Attributes:
-
activation_type(ActivationType) – -
application_eui(str | None) – -
application_key(str | None) – -
application_s_key(str | None) – -
decoder_type(str | None) – -
dev_addr(str | None) – -
deveui(str) – -
device_profile(str) – -
name(str) – -
network_s_key(str | None) – -
network_skey(str | None) – -
output_profile(str | None) – -
private_data(bool) – -
service_profile(str) –
DeviceCreateResponse
DeviceError
DeviceFilter
DeviceInstance
Bases: BaseModelWithConfig
Attributes:
-
activation_type(str) – -
created_at(datetime) – -
decoder_type(str) – -
deveui(str) – -
device_profile(str) – -
last_uplink(datetime | None) – -
name(str) – -
output_profile(str) – -
payload_decoder(PayloadDecoderType) – -
private_data(bool) – -
service_profile(str) – -
statistics(DeviceStatistics) – -
updated_at(datetime) – -
updated_by(str) –
DeviceMessage
Bases: BaseModelWithConfig
Methods:
Attributes:
-
application_payload(dict[str, Any] | None) – -
confirm(bool) – -
flush_queue(bool) – -
payload(str | None) – -
target_port(int | None) –
application_payload
class-attribute
instance-attribute
DevicePatch
Bases: BaseModelWithConfig
Attributes:
-
decoder_type(str | None) – -
device_profile(str | None) – -
name(str | None) – -
output_profile(str | None) – -
private_data(bool | None) – -
remove_output_profile(bool | None) – -
service_profile(str | None) –
DevicePayload
DevicePayloadResponse
DeviceResponse
DeviceStatistics
Bases: BaseModelWithConfig
Attributes:
-
average_esp(float) – -
average_rssi(float) – -
average_snr(float) – -
average_weekly_packets(int) – -
battery_level(int) – -
health_state(str) – -
packet_error_rate(float) – -
spreading_factor(int) –
DeviceUpdate
Bases: BaseModelWithConfig
Attributes:
-
decoder_type(str | None) – -
device_profile(str) – -
name(str) – -
output_profile(str | None) – -
private_data(bool | None) – -
service_profile(str) –
DevicesHealthCountResponse
DevicesHealthResponse
Bases: BaseModelWithConfig
Attributes:
-
fair(list[DeviceInstance]) – -
good(list[DeviceInstance]) – -
offline(list[DeviceInstance]) – -
poor(list[DeviceInstance]) –