Skip to content
LocalStack DocsLocalStack DocsDocs
Get Started for Free

IoT Wireless

Introduction

Section titled “Introduction”

AWS IoT Wireless is a managed service that enables customers to connect and manage wireless devices. The service provides a set of APIs to manage wireless devices, gateways, and destinations.

LocalStack allows you to use the IoT Wireless APIs in your local environment from creating wireless devices and gateways. The supported APIs are available on our API Coverage section, which provides information on the extent of IoT Wireless’s integration with LocalStack.

Getting started

Section titled “Getting started”

This guide is designed for users new to IoT Wireless and assumes basic knowledge of the AWS CLI and our lstk aws command.

Start your LocalStack container using your preferred method. We will demonstrate how to use IoT Wireless to create wireless devices and gateways with the AWS CLI.

Create a Wireless Device

Section titled “Create a Wireless Device”

You can create a wireless device using the CreateWirelessDevice API. Run the following command to create a wireless device:

Terminal window
lstk aws iotwireless create-device-profile

The following output would be retrieved:

Output
{
    "Id": "b8a8e3a8"
}

You can list the device profiles using the ListDeviceProfiles API. Run the following command to list the device profiles:

Terminal window
lstk aws iotwireless list-device-profiles

The following output would be retrieved:

Output
{
    "DeviceProfileList": [
        {
            "Id": "b8a8e3a8"
        }
    ]
}

Create a Wireless device

Section titled “Create a Wireless device”

You can create a wireless device using the CreateWirelessDevice API. Run the following command to create a wireless device:

Terminal window
lstk aws iotwireless create-wireless-device \
    --cli-input-json file://input.json

The input.json file contains the following content:

input.json
{
    "Description": "My LoRaWAN wireless device",
    "DestinationName": "IoTWirelessDestination",
    "LoRaWAN": {
        "DeviceProfileId": "ab0c23d3-b001-45ef-6a01-2bc3de4f5333",
        "ServiceProfileId": "fe98dc76-cd12-001e-2d34-5550432da100",
        "OtaaV1_1": {
            "AppKey": "3f4ca100e2fc675ea123f4eb12c4a012",
            "JoinEui": "b4c231a359bc2e3d",
            "NwkKey": "01c3f004a2d6efffe32c4eda14bcd2b4"
        },
        "DevEui": "ac12efc654d23fc2"
    },
    "Name": "SampleIoTWirelessThing",
    "Type": "LoRaWAN"
}

You can list the wireless devices using the ListWirelessDevices API. Run the following command to list the wireless devices:

Terminal window
lstk aws iotwireless list-wireless-devices

The following output would be retrieved:

Output
{
    "WirelessDeviceList": [
        {
            "Id": "0bca2fe2",
            "Type": "LoRaWAN",
            "Name": "SampleIoTWirelessThing",
            "DestinationName": "IoTWirelessDestination",
            "LoRaWAN": {
                "DevEui": "ac12efc654d23fc2"
            }
        }
    ]
}

Create a Wireless Gateway

Section titled “Create a Wireless Gateway”

You can create a wireless gateway using the CreateWirelessGateway API. Run the following command to create a wireless gateway:

Terminal window
lstk aws iotwireless create-wireless-gateway \
    --lorawan GatewayEui="a1b2c3d4567890ab",RfRegion="US915" \
    --name "myFirstLoRaWANGateway" \
    --description "Using my first LoRaWAN gateway"

The following output would be retrieved:

Output
{
    "Id": "e519dc4e"
}

You can list the wireless gateways using the ListWirelessGateways API. Run the following command to list the wireless gateways:

Terminal window
lstk aws iotwireless list-wireless-gateways

The following output would be retrieved:

Output
{
    "WirelessGatewayList": [
        {
            "Id": "e519dc4e",
            "Name": "myFirstLoRaWANGateway",
            "Description": "Using my first LoRaWAN gateway",
            "LoRaWAN": {
                "GatewayEui": "a1b2c3d4567890ab",
                "RfRegion": "US915"
            }
        }
    ]
}

API Coverage

Section titled “API Coverage”

22 of 112 operations implemented

Available from the Ultimate plan. Licensing details

Find an API

Search the full operation list, then sort the table to compare current support.

Loading operations…

Verified on Kubernetes
Loading operations…
Complete static API list All 112 operations and their current support status
OperationStatus
AssociateAwsAccountWithPartnerAccountNot implemented
AssociateMulticastGroupWithFuotaTaskNot implemented
AssociateWirelessDeviceWithFuotaTaskNot implemented
AssociateWirelessDeviceWithMulticastGroupNot implemented
AssociateWirelessDeviceWithThingNot implemented
AssociateWirelessGatewayWithCertificateNot implemented
AssociateWirelessGatewayWithThingNot implemented
CancelMulticastGroupSessionNot implemented
CreateDestinationImplemented
CreateDeviceProfileImplemented
CreateFuotaTaskNot implemented
CreateMulticastGroupNot implemented
CreateNetworkAnalyzerConfigurationNot implemented
CreateServiceProfileImplemented
CreateWirelessDeviceImplemented
CreateWirelessGatewayImplemented
CreateWirelessGatewayTaskNot implemented
CreateWirelessGatewayTaskDefinitionNot implemented
DeleteDestinationImplemented
DeleteDeviceProfileImplemented
DeleteFuotaTaskNot implemented
DeleteMulticastGroupNot implemented
DeleteNetworkAnalyzerConfigurationNot implemented
DeleteQueuedMessagesNot implemented
DeleteServiceProfileImplemented
DeleteWirelessDeviceImplemented
DeleteWirelessDeviceImportTaskNot implemented
DeleteWirelessGatewayImplemented
DeleteWirelessGatewayTaskNot implemented
DeleteWirelessGatewayTaskDefinitionNot implemented
DeregisterWirelessDeviceNot implemented
DisassociateAwsAccountFromPartnerAccountNot implemented
DisassociateMulticastGroupFromFuotaTaskNot implemented
DisassociateWirelessDeviceFromFuotaTaskNot implemented
DisassociateWirelessDeviceFromMulticastGroupNot implemented
DisassociateWirelessDeviceFromThingNot implemented
DisassociateWirelessGatewayFromCertificateNot implemented
DisassociateWirelessGatewayFromThingNot implemented
GetDestinationImplemented
GetDeviceProfileImplemented
GetEventConfigurationByResourceTypesNot implemented
GetFuotaTaskNot implemented
GetLogLevelsByResourceTypesNot implemented
GetMetricConfigurationNot implemented
GetMetricsNot implemented
GetMulticastGroupNot implemented
GetMulticastGroupSessionNot implemented
GetNetworkAnalyzerConfigurationNot implemented
GetPartnerAccountNot implemented
GetPositionNot implemented
GetPositionConfigurationNot implemented
GetPositionEstimateNot implemented
GetResourceEventConfigurationNot implemented
GetResourceLogLevelNot implemented
GetResourcePositionNot implemented
GetServiceEndpointNot implemented
GetServiceProfileImplemented
GetWirelessDeviceImplemented
GetWirelessDeviceImportTaskNot implemented
GetWirelessDeviceStatisticsNot implemented
GetWirelessGatewayImplemented
GetWirelessGatewayCertificateNot implemented
GetWirelessGatewayFirmwareInformationNot implemented
GetWirelessGatewayStatisticsNot implemented
GetWirelessGatewayTaskNot implemented
GetWirelessGatewayTaskDefinitionNot implemented
ListDestinationsImplemented
ListDeviceProfilesImplemented
ListDevicesForWirelessDeviceImportTaskNot implemented
ListEventConfigurationsNot implemented
ListFuotaTasksNot implemented
ListMulticastGroupsNot implemented
ListMulticastGroupsByFuotaTaskNot implemented
ListNetworkAnalyzerConfigurationsNot implemented
ListPartnerAccountsNot implemented
ListPositionConfigurationsNot implemented
ListQueuedMessagesNot implemented
ListServiceProfilesImplemented
ListTagsForResourceNot implemented
ListWirelessDeviceImportTasksNot implemented
ListWirelessDevicesImplemented
ListWirelessGatewayTaskDefinitionsNot implemented
ListWirelessGatewaysImplemented
PutPositionConfigurationNot implemented
PutResourceLogLevelNot implemented
ResetAllResourceLogLevelsNot implemented
ResetResourceLogLevelNot implemented
SendDataToMulticastGroupNot implemented
SendDataToWirelessDeviceNot implemented
StartBulkAssociateWirelessDeviceWithMulticastGroupNot implemented
StartBulkDisassociateWirelessDeviceFromMulticastGroupNot implemented
StartFuotaTaskNot implemented
StartMulticastGroupSessionNot implemented
StartSingleWirelessDeviceImportTaskNot implemented
StartWirelessDeviceImportTaskNot implemented
TagResourceNot implemented
TestWirelessDeviceNot implemented
UntagResourceNot implemented
UpdateDestinationNot implemented
UpdateEventConfigurationByResourceTypesNot implemented
UpdateFuotaTaskNot implemented
UpdateLogLevelsByResourceTypesNot implemented
UpdateMetricConfigurationNot implemented
UpdateMulticastGroupNot implemented
UpdateNetworkAnalyzerConfigurationNot implemented
UpdatePartnerAccountNot implemented
UpdatePositionNot implemented
UpdateResourceEventConfigurationNot implemented
UpdateResourcePositionNot implemented
UpdateWirelessDeviceImplemented
UpdateWirelessDeviceImportTaskNot implemented
UpdateWirelessGatewayImplemented
Was this page helpful?