Gateway models

Attributes:

• X (str) –
• Y (str) –
• Z (str) –

X: str

Y: str

Z: str = '1'

Attributes:

• error (str) –
• id (str) –
• mac_address (str) –
• response (bool) –

error: str

id: str

mac_address: str

response: bool

Attributes:

• activated (bool) –
• subscriber_id (str) –

activated: bool

subscriber_id: str = Field(alias='subscriberId')

Attributes:

• ICCID (str | None) –

  ICCID for cellular backhaul. This field is optional if CellularEnabled is true. <20 digit number>.

• IMEI (str | None) –

  IMEI for cellular backhaul. This field is optional if CellularEnabled is true.

• antenna_gain (str) –
• cellular_enabled (bool | None) –
• coordinates (Coordinates) –
• gateway_profile (str) –
• gps_enabled (bool | None) –
• location_type (LocationType) –
• mac_address (str) –
• name (str) –
• node_id (str) –

ICCID: str | None = Field(
    default=None,
    serialization_alias="ICCID",
    validation_alias="ICCID",
    max_length=20,
    min_length=20,
)

IMEI: str | None = None

antenna_gain: str = '0'

cellular_enabled: bool | None = None

coordinates: Coordinates

gateway_profile: str

gps_enabled: bool | None = Field(
    default=None, alias="GPSEnabled"
)

location_type: LocationType = INDOOR

mac_address: str

name: str

node_id: str

Attributes:

• id (str) –

id: str

Attributes:

• deveui (str) –
• last_uplink (datetime) –
• name (str) –
• statistics (str) –

deveui: str

last_uplink: datetime

name: str

statistics: str

Attributes:

• devices (list[GatewayDevice]) –

devices: list[GatewayDevice]

Attributes:

• response (bool) –

response: bool

Attributes:

• field (GatewayEventField) –
• new_value (str) –
• old_value (str) –
• time (str) –

field: GatewayEventField

new_value: str

old_value: str

time: str

Attributes:

• BACKHAUL –
• BACKHAUL_CONNECTED –
• BACKHAUL_DISCONNECTED –
• NS_CONNECT –
• ONLINE_STATUS –
• PACKET_FORWARDER –
• PACKET_FORWARDER_CONNECTED –
• PACKET_FORWARDER_DISCONNECTED –
• PUSH_RF_CONFIG –
• REBOOT_TIME –
• UNKNOWN –

BACKHAUL = 'BACKHAUL'

BACKHAUL_CONNECTED = 'BACKHAUL_CONNECTED'

BACKHAUL_DISCONNECTED = 'BACKHAUL_DISCONNECTED'

NS_CONNECT = 'NS_CONNECT'

ONLINE_STATUS = 'ONLINE_STATUS'

PACKET_FORWARDER = 'PACKET_FORWARDER'

PACKET_FORWARDER_CONNECTED = 'PACKET_FORWARDER_CONNECTED'

PACKET_FORWARDER_DISCONNECTED = (
    "PACKET_FORWARDER_DISCONNECTED"
)

PUSH_RF_CONFIG = 'PUSH_RF_CONFIG'

REBOOT_TIME = 'REBOOT_TIME'

UNKNOWN = 'UNKNOWN'

Attributes:

• events (list[GatewayEvent]) –
• node_id (str) –

events: list[GatewayEvent]

node_id: str = Field(alias='NodeID')

Attributes:

• LOCKED –
• LOCKING_OR_NO_SIGNAL –

LOCKED = 'LOCKED'

LOCKING_OR_NO_SIGNAL = 'LOCKING_OR_NO_SIGNAL'

Attributes:

• ICCID (str) –
• IMEI (str) –
• antenna_gain (str) –
• cellular_enabled (bool) –
• coordinates (Coordinates) –
• created_at (datetime) –
• gateway_profile (str) –
• gps_enabled (bool) –
• id (str) –
• location_type (LocationType) –
• mac_address (str) –
• manufacturer (MachineqapiGatewayManufacturer) –
• model (str) –
• name (str) –
• node_id (str) –
• rf_region (str) –
• statistics (GatewayStatistics | None) –
• updated_at (datetime) –
• updated_by (str) –

ICCID: str

IMEI: str

antenna_gain: str

cellular_enabled: bool

coordinates: Coordinates

created_at: datetime

gateway_profile: str

gps_enabled: bool = Field(alias='GPSEnabled')

id: str

location_type: LocationType

mac_address: str

manufacturer: MachineqapiGatewayManufacturer

model: str

name: str

node_id: str

rf_region: str

statistics: GatewayStatistics | None

updated_at: datetime

updated_by: str

Attributes:

• AS923 –
• AU915 –
• CN470 –
• CN779 –
• EU433 –
• EU868 –
• IN865 –
• KR920 –
• RU864 –
• SG920 –
• TW920 –
• US915 –

AS923 = 'AS923'

AU915 = 'AU915'

CN470 = 'CN470'

CN779 = 'CN779'

EU433 = 'EU433'

EU868 = 'EU868'

IN865 = 'IN865'

KR920 = 'KR920'

RU864 = 'RU864'

SG920 = 'SG920'

TW920 = 'TW920'

US915 = 'US915'

Attributes:

• LOCATION_ADMINISTRATIVELY –
• LOCATION_GPS –
• LOCATION_UNKNOWN –

LOCATION_ADMINISTRATIVELY = 'LOCATION_ADMINISTRATIVELY'

LOCATION_GPS = 'LOCATION_GPS'

LOCATION_UNKNOWN = 'LOCATION_UNKNOWN'

Attributes:

• ICCID (str | None) –

  ICCID for cellular backhaul. This field is optional if CellularEnabled is true. <20 digit number>.

• IMEI (str | None) –

  IMEI for cellular backhaul. This field is optional if CellularEnabled is true.

• antenna_gain (str | None) –
• cellular_enabled (bool | None) –
• coordinates (Coordinates | None) –
• gateway_profile (str | None) –
• gps_enabled (bool | None) –
• location_type (LocationType | None) –
• name (str | None) –
• rf_region (str | None) –

ICCID: str | None = Field(
    default=None,
    serialization_alias="ICCID",
    validation_alias="ICCID",
    max_length=20,
    min_length=20,
)

IMEI: str | None = None

antenna_gain: str | None = None

cellular_enabled: bool | None = None

coordinates: Coordinates | None = None

gateway_profile: str | None = None

gps_enabled: bool | None = Field(
    default=None, alias="GPSEnabled"
)

location_type: LocationType | None = None

name: str | None = None

rf_region: str | None = None

Attributes:

• VSWR (int) –
• cell_provider (str) –
• cell_rssi (int) –
• connection_state (MachineqapiGatewayConnectionState) –
• cpu_percent (int) –
• downlink_packet_per_hour (int) –
• free_mem_kb (int) –
• gps_sync_status (GatewayGpsSyncStatus) –
• health_state (MachineqapiGatewayHealthState) –
• interface_statistics (list[InterfaceStatistics]) –
• is_rx2_activated (bool) –
• ism_band (GatewayIsmBand) –
• last_downlink_time (datetime | None) –
• last_geo_altitude (float) –
• last_geo_latitude (float) –
• last_geo_longitude (float) –
• last_geo_valid (bool) –
• last_reporting_time (datetime | None) –
• last_system_reboot (datetime | None) –
• last_uplink_time (datetime | None) –
• location_type (GatewayLocationType) –
• lrr_cnx (bool) –
• model (str) –
• radio_error (str) –
• rf_region_id (str) –
• secure_backhaul_active (bool) –
• secure_backhaul_enabled (bool) –
• software_version (str) –
• time_sync_status (GatewayTimeSyncStatus) –
• tx_power (int) –
• uplink_packet_per_hour (int) –
• wifi_ssid (str) –

VSWR: int

cell_provider: str

cell_rssi: int = Field(alias='CellRSSI')

connection_state: MachineqapiGatewayConnectionState

cpu_percent: int = Field(alias='CPUPercent')

downlink_packet_per_hour: int

free_mem_kb: int = Field(alias='FreeMemKB')

gps_sync_status: GatewayGpsSyncStatus

health_state: MachineqapiGatewayHealthState

interface_statistics: list[InterfaceStatistics]

is_rx2_activated: bool = Field(alias='IsRX2Activated')

ism_band: GatewayIsmBand

last_downlink_time: datetime | None

last_geo_altitude: float

last_geo_latitude: float

last_geo_longitude: float

last_geo_valid: bool

last_reporting_time: datetime | None

last_system_reboot: datetime | None

last_uplink_time: datetime | None

location_type: GatewayLocationType

lrr_cnx: bool = Field(alias='LrrCNX')

model: str

radio_error: str

rf_region_id: str = Field(alias='RfRegionID')

secure_backhaul_active: bool

secure_backhaul_enabled: bool

software_version: str

time_sync_status: GatewayTimeSyncStatus

tx_power: int

uplink_packet_per_hour: int

wifi_ssid: str = Field(alias='WiFiSSID')

Attributes:

• GPS –
• LOCAL –
• NTP –

GPS = 'GPS'

LOCAL = 'LOCAL'

NTP = 'NTP'

Attributes:

• ICCID (str | None) –

  ICCID for cellular backhaul. This field is optional if CellularEnabled is true. <20 digit number>.

• IMEI (str | None) –

  IMEI for cellular backhaul. This field is optional if CellularEnabled is true.

• antenna_gain (str) –
• cellular_enabled (bool | None) –
• coordinates (Coordinates | None) –
• gateway_profile (str) –
• gps_enabled (bool | None) –
• location_type (LocationType) –
• name (str) –

ICCID: str | None = Field(
    default=None,
    serialization_alias="ICCID",
    validation_alias="ICCID",
    max_length=20,
    min_length=20,
)

IMEI: str | None = None

antenna_gain: str

cellular_enabled: bool | None

coordinates: Coordinates | None

gateway_profile: str

gps_enabled: bool | None = Field(
    default=None, alias="GPSEnabled"
)

location_type: LocationType

name: str

Attributes:

• connected (list[GatewayInstance]) –
• disconnected (list[GatewayInstance]) –
• never_connected (list[GatewayInstance]) –

connected: list[GatewayInstance]

disconnected: list[GatewayInstance]

never_connected: list[GatewayInstance]

Attributes:

• active (list[GatewayInstance]) –
• connect_error (list[GatewayInstance]) –
• initializing (list[GatewayInstance]) –
• rf_error (list[GatewayInstance]) –

active: list[GatewayInstance]

connect_error: list[GatewayInstance]

initializing: list[GatewayInstance]

rf_error: list[GatewayInstance]

Attributes:

• DOWN –
• IF_UNKNOWN –
• UP_LINKDOWN –
• UP_NETWORKDOWN –
• UP_NOIP –
• UP_NOSIGNAL –
• UP_RUNNING –
• UP_RUNNING_USED –

DOWN = 'DOWN'

IF_UNKNOWN = 'IF_UNKNOWN'

UP_LINKDOWN = 'UP_LINKDOWN'

UP_NETWORKDOWN = 'UP_NETWORKDOWN'

UP_NOIP = 'UP_NOIP'

UP_NOSIGNAL = 'UP_NOSIGNAL'

UP_RUNNING = 'UP_RUNNING'

UP_RUNNING_USED = 'UP_RUNNING_USED'

Attributes:

• name (str) –
• state (InterfaceState) –
• type (str) –

name: str

state: InterfaceState

type: str

Attributes:

• INDOOR –
• OUTDOOR –

INDOOR = 'INDOOR'

OUTDOOR = 'OUTDOOR'

Attributes:

• CNX –
• CNX_UNKNOWN –
• DISC –
• NEVERCNX –

CNX = 'CNX'

CNX_UNKNOWN = 'CNX_UNKNOWN'

DISC = 'DISC'

NEVERCNX = 'NEVERCNX'

Attributes:

• ACTIVE –
• BACKHAUL_CNX_ERROR –
• HEALTH_UNKNOWN –
• INIT –
• RF_ERROR –

ACTIVE = 'ACTIVE'

BACKHAUL_CNX_ERROR = 'BACKHAUL_CNX_ERROR'

HEALTH_UNKNOWN = 'HEALTH_UNKNOWN'

INIT = 'INIT'

RF_ERROR = 'RF_ERROR'

Attributes:

• COMCAST –
• MULTITECH –
• TEKTELIC –
• UNKNOWN_MFR –

COMCAST = 'COMCAST'

MULTITECH = 'MULTITECH'

TEKTELIC = 'TEKTELIC'

UNKNOWN_MFR = 'UNKNOWN_MFR'

Attributes:

• gateways (list[GatewayInstance]) –

gateways: list[GatewayInstance]