Skip to content

Logs models

Request and response types for the Logs API.

models

Classes:

AckFilter

Bases: str, Enum

Attributes:

ACKFALSE class-attribute instance-attribute

ACKFALSE = 'ACKFALSE'

ACKTRUE class-attribute instance-attribute

ACKTRUE = 'ACKTRUE'

NOACKFILTER class-attribute instance-attribute

NOACKFILTER = 'NOACKFILTER'

ActivationFilter

Bases: str, Enum

Attributes:

JOINACCEPT class-attribute instance-attribute

JOINACCEPT = 'JOINACCEPT'

JOINREQUEST class-attribute instance-attribute

JOINREQUEST = 'JOINREQUEST'

NOACTIVATIONFILTER class-attribute instance-attribute

NOACTIVATIONFILTER = 'NOACTIVATIONFILTER'

GatewayList

Bases: BaseModelWithConfig

Attributes:

ESP instance-attribute

ESP: str

RSSI instance-attribute

RSSI: str

SNR instance-attribute

SNR: str

gateway instance-attribute

gateway: str

gateway_node_id class-attribute instance-attribute

gateway_node_id: str = Field(alias='GatewayNodeID')

subscriber_id class-attribute instance-attribute

subscriber_id: str = Field(alias="SubscriberID", default="")

time instance-attribute

time: str

unowned class-attribute instance-attribute

unowned: bool = False

This flag will be true when the primary gateway is not owned by the same subscriber as the one initiating the API request. Note that MachineQ uses unowned and not owned because they want the default value, i.e. false, to be omitted in the JSON.

LateFilter

Bases: str, Enum

Attributes:

LATEFALSE class-attribute instance-attribute

LATEFALSE = 'LATEFALSE'

LATETRUE class-attribute instance-attribute

LATETRUE = 'LATETRUE'

NOLATEFILTER class-attribute instance-attribute

NOLATEFILTER = 'NOLATEFILTER'

LogFrameFilter

Bases: BaseModelWithConfig

Attributes:

ack instance-attribute

activation instance-attribute

activation: list[ActivationFilter]

late instance-attribute

message_type instance-attribute

message_type: list[MessageTypeFilter]

stream instance-attribute

stream: list[StreamFilter]

LogInstance

Bases: BaseModelWithConfig

Attributes:

ack_bit class-attribute instance-attribute

ack_bit: str = Field(alias='ACKbit')

ack_requested class-attribute instance-attribute

ack_requested: str = Field(alias='AckRequested')

adr_ack_req class-attribute instance-attribute

adr_ack_req: str = Field(alias='ADRAckReq')

adr_bit class-attribute instance-attribute

adr_bit: str = Field(alias='ADRbit')

airtime instance-attribute

airtime: str

channel instance-attribute

channel: str

decoded_mac_commands instance-attribute

decoded_mac_commands: list[str]

dev_addr instance-attribute

dev_addr: str

dev_nonce instance-attribute

dev_nonce: str

deveui instance-attribute

deveui: str

device_latitude instance-attribute

device_latitude: str

device_location_radius instance-attribute

device_location_radius: str

device_longitude instance-attribute

device_longitude: str

f_cnt instance-attribute

f_cnt: str

f_pending instance-attribute

f_pending: str

fport instance-attribute

fport: str

gateway_count instance-attribute

gateway_count: str

gateway_id class-attribute instance-attribute

gateway_id: str = Field(alias='GatewayID')

gateway_latitude class-attribute instance-attribute

gateway_latitude: str = Field(alias='GatewayLatitide')

gateway_list instance-attribute

gateway_list: list[GatewayList]

gateway_longitude instance-attribute

gateway_longitude: str

gateway_node_id class-attribute instance-attribute

gateway_node_id: str = Field(alias='GatewayNodeID')

Could be "Not Owned" or the NodeID

gateway_subscriber_id class-attribute instance-attribute

gateway_subscriber_id: str = ''

gateway_unowned class-attribute instance-attribute

gateway_unowned: bool = False

This flag will be true when the primary gateway is not owned by the same subscriber as the one initiating the API request. Note that MachineQ uses unowned and not owned because they want the default value, i.e. false, to be omitted in the JSON.

join_eui class-attribute instance-attribute

join_eui: str = Field(alias='JoinEUI')

late instance-attribute

late: str

mac_commands instance-attribute

mac_commands: str

message_type instance-attribute

message_type: str

message_type_text instance-attribute

message_type_text: str

mic_hex class-attribute instance-attribute

mic_hex: str = Field(alias='MICHex')

multicast class-attribute instance-attribute

multicast: bool = False

payload_decoded class-attribute instance-attribute

payload_decoded: dict[str, Any] | None = Field(
    default_factory=dict
)

payload_hex instance-attribute

payload_hex: str

primary_gateway_e_s_p instance-attribute

primary_gateway_e_s_p: str

primary_gateway_rssi class-attribute instance-attribute

primary_gateway_rssi: str = Field(
    alias="PrimaryGatewayRSSI"
)

primary_gateway_snr class-attribute instance-attribute

primary_gateway_snr: str = Field(alias='PrimaryGatewaySNR')

spreading_factor instance-attribute

spreading_factor: str

sub_band instance-attribute

sub_band: str

timestamp instance-attribute

timestamp: datetime

LogResponse

Bases: BaseModelWithConfig

Attributes:

logs instance-attribute

MessageTypeFilter

Bases: str, Enum

Attributes:

DATA class-attribute instance-attribute

DATA = 'DATA'

MAC class-attribute instance-attribute

MAC = 'MAC'

MACDATA class-attribute instance-attribute

MACDATA = 'MACDATA'

NOMESSAGETYPEFILTER class-attribute instance-attribute

NOMESSAGETYPEFILTER = 'NOMESSAGETYPEFILTER'

NONE class-attribute instance-attribute

NONE = 'NONE'

StreamFilter

Bases: str, Enum

Attributes:

DOWNSTREAM class-attribute instance-attribute

DOWNSTREAM = 'DOWNSTREAM'

NOSTREAMFILTER class-attribute instance-attribute

NOSTREAMFILTER = 'NOSTREAMFILTER'

UPSTREAM class-attribute instance-attribute

UPSTREAM = 'UPSTREAM'