Logs models
Request and response types for the Logs API.
models
Classes:
-
AckFilter– -
ActivationFilter– -
GatewayList– -
LateFilter– -
LogFrameFilter– -
LogInstance– -
LogResponse– -
MessageTypeFilter– -
StreamFilter–
AckFilter
Attributes:
-
ACKFALSE– -
ACKTRUE– -
NOACKFILTER–
ACKFALSE
class-attribute
instance-attribute
ACKFALSE = 'ACKFALSE'
ACKTRUE
class-attribute
instance-attribute
ACKTRUE = 'ACKTRUE'
NOACKFILTER
class-attribute
instance-attribute
NOACKFILTER = 'NOACKFILTER'
ActivationFilter
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(str) – -
RSSI(str) – -
SNR(str) – -
gateway(str) – -
gateway_node_id(str) – -
subscriber_id(str) – -
time(str) – -
unowned(bool) –This flag will be true when the primary gateway is not owned by the same subscriber as the one initiating
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="")
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
Attributes:
-
LATEFALSE– -
LATETRUE– -
NOLATEFILTER–
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(list[AckFilter]) – -
activation(list[ActivationFilter]) – -
late(list[LateFilter]) – -
message_type(list[MessageTypeFilter]) – -
stream(list[StreamFilter]) –
LogInstance
Bases: BaseModelWithConfig
Attributes:
-
ack_bit(str) – -
ack_requested(str) – -
adr_ack_req(str) – -
adr_bit(str) – -
airtime(str) – -
channel(str) – -
decoded_mac_commands(list[str]) – -
dev_addr(str) – -
dev_nonce(str) – -
deveui(str) – -
device_latitude(str) – -
device_location_radius(str) – -
device_longitude(str) – -
f_cnt(str) – -
f_pending(str) – -
fport(str) – -
gateway_count(str) – -
gateway_id(str) – -
gateway_latitude(str) – -
gateway_list(list[GatewayList]) – -
gateway_longitude(str) – -
gateway_node_id(str) –Could be "Not Owned" or the NodeID
-
gateway_subscriber_id(str) – -
gateway_unowned(bool) –This flag will be true when the primary gateway is not owned by the same subscriber as the one initiating
-
join_eui(str) – -
late(str) – -
mac_commands(str) – -
message_type(str) – -
message_type_text(str) – -
mic_hex(str) – -
multicast(bool) – -
payload_decoded(dict[str, Any] | None) – -
payload_hex(str) – -
primary_gateway_e_s_p(str) – -
primary_gateway_rssi(str) – -
primary_gateway_snr(str) – -
spreading_factor(str) – -
sub_band(str) – -
timestamp(datetime) –
gateway_latitude
class-attribute
instance-attribute
gateway_latitude: str = Field(alias='GatewayLatitide')
gateway_node_id
class-attribute
instance-attribute
gateway_node_id: str = Field(alias='GatewayNodeID')
Could be "Not Owned" or the NodeID
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.
payload_decoded
class-attribute
instance-attribute
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')
LogResponse
MessageTypeFilter
Attributes:
-
DATA– -
MAC– -
MACDATA– -
NOMESSAGETYPEFILTER– -
NONE–
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
Attributes:
-
DOWNSTREAM– -
NOSTREAMFILTER– -
UPSTREAM–
DOWNSTREAM
class-attribute
instance-attribute
DOWNSTREAM = 'DOWNSTREAM'
NOSTREAMFILTER
class-attribute
instance-attribute
NOSTREAMFILTER = 'NOSTREAMFILTER'
UPSTREAM
class-attribute
instance-attribute
UPSTREAM = 'UPSTREAM'