get-wireless-device-statistics¶

Description¶

Gets operating information about a wireless device.

Synopsis¶

  get-wireless-device-statistics
--wireless-device-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--wireless-device-id (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To get operating information about a wireless device

The following get-wireless-device-statistics example gets operating information about a wireless device.

aws iotwireless get-wireless-device-statistics \
    --wireless-device-id "1ffd32c8-8130-4194-96df-622f072a315f"

Output:

{
    "WirelessDeviceId": "1ffd32c8-8130-4194-96df-622f072a315f"
}

For more information, see Connecting devices and gateways to AWS IoT Core for LoRaWAN in the AWS IoT Developers Guide.

Output¶

WirelessDeviceId -> (string)

The ID of the wireless device.

LastUplinkReceivedAt -> (string)

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

LoRaWAN -> (structure)

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.

(structure)

LoRaWAN gateway metatdata.

GatewayEui -> (string)

The gateway’s EUI value.

Snr -> (double)

The SNR value.

Rssi -> (double)

The RSSI value.

Sidewalk -> (structure)

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.

Table of Contents

Feedback

User Guide