IoTWireless / Client / get_wireless_device_statistics

get_wireless_device_statistics

IoTWireless.Client.get_wireless_device_statistics(**kwargs)

Gets operating information about a wireless device.

See also: AWS API Documentation

Request Syntax

response = client.get_wireless_device_statistics(
    WirelessDeviceId='string'
)

Parameters:

WirelessDeviceId (string) –

[REQUIRED]

The ID of the wireless device for which to get the data.

Return type:

dict

Returns:

Response Syntax

{
    'WirelessDeviceId': 'string',
    'LastUplinkReceivedAt': 'string',
    'LoRaWAN': {
        'DevEui': 'string',
        'FPort': 123,
        'DataRate': 123,
        'Frequency': 123,
        'Timestamp': 'string',
        'Gateways': [
            {
                'GatewayEui': 'string',
                'Snr': 123.0,
                'Rssi': 123.0
            },
        ],
        'PublicGateways': [
            {
                'ProviderNetId': 'string',
                'Id': 'string',
                'Rssi': 123.0,
                'Snr': 123.0,
                'RfRegion': 'string',
                'DlAllowed': True|False
            },
        ]
    },
    'Sidewalk': {
        'Rssi': 123,
        'BatteryLevel': 'normal'|'low'|'critical',
        'Event': 'discovered'|'lost'|'ack'|'nack'|'passthrough',
        'DeviceState': 'Provisioned'|'RegisteredNotSeen'|'RegisteredReachable'|'RegisteredUnreachable'
    }
}

Response Structure

• (dict) –

  • WirelessDeviceId (string) –

    The ID of the wireless device.

  • LastUplinkReceivedAt (string) –

    The date and time when the most recent uplink was received.

    Note

    This value is only valid for 3 months.

  • LoRaWAN (dict) –

    Information about the wireless device’s operations.

    • DevEui (string) –

      The DevEUI value.

    • FPort (integer) –

      The FPort value.

    • DataRate (integer) –

      The DataRate value.

    • Frequency (integer) –

      The device’s channel frequency in Hz.

    • Timestamp (string) –

      The date and time of the metadata.

    • Gateways (list) –

      Information about the gateways accessed by the device.

      • (dict) –

        LoRaWAN gateway metatdata.

        • GatewayEui (string) –

          The gateway’s EUI value.

        • Snr (float) –

          The SNR value.

        • Rssi (float) –

          The RSSI value.

    • PublicGateways (list) –

      Information about the LoRaWAN public network accessed by the device.

      • (dict) –

        LoRaWAN public gateway metadata.

        • ProviderNetId (string) –

          The ID of the LoRaWAN public network provider.

        • Id (string) –

          The ID of the gateways that are operated by the network provider.

        • Rssi (float) –

          The RSSI (received signal strength indicator) value.

        • Snr (float) –

          The SNR (signal to noise ratio) value.

        • RfRegion (string) –

          The frequency band (RFRegion) value.

        • DlAllowed (boolean) –

          Boolean that indicates whether downlink is allowed using the network.

  • Sidewalk (dict) –

    MetaData for Sidewalk device.

    • Rssi (integer) –

      The RSSI value.

    • BatteryLevel (string) –

      Sidewalk device battery level.

    • Event (string) –

      Sidewalk device status notification.

    • DeviceState (string) –

      Device state defines the device status of sidewalk device.

Exceptions

• IoTWireless.Client.exceptions.ValidationException

• IoTWireless.Client.exceptions.AccessDeniedException

• IoTWireless.Client.exceptions.ResourceNotFoundException

• IoTWireless.Client.exceptions.InternalServerException

• IoTWireless.Client.exceptions.ThrottlingException