Add a gateway to AWS IoT Core for LoRaWAN

You can add your gateway to AWS IoT Core for LoRaWAN by using the console or the CLI.

Before adding your gateway, we recommend that you consider the factors mentioned in the Before onboarding your gateway section of Onboard your gateways to AWS IoT Core for LoRaWAN.

If you're adding your gateway for the first time, we recommend that you use the console. If you want to add your gateway by using the CLI instead, you must have already created the necessary IAM role so that the gateway can connect with AWS IoT Core for LoRaWAN. For information about how to create the role, see Add an IAM role to allow the Configuration and Update Server (CUPS) to manage gateway credentials.

Add a gateway using the console

Navigate to the AWS IoT Core for LoRaWAN Intro page of the AWS IoT console and choose Get started, and then choose Add gateway. If you've already added a gateway, choose View gateway to view the gateway that you added. If you would like to add more gateways, choose Add gateway.

Add a gateway by using the API

The following sections show how to add a gateway using the AWS IoT Wireless API operations or the AWS CLI. You first add your gateway and then associate a certificate with the gateway. You can also use the additional API operations, such as to update an existing gateway.

How to add your gateway

You can use the AWS CLI to create a wireless gateway by using the CreateWirelessGateway API operation or the create-wireless-gateway CLI command to add your wireless gateway.

The following example creates a wireless LoRaWAN device gateway. You can also provide an input.json file that will contain additional details such as the gateway certificate and provisioning credentials.

aws iotwireless create-wireless-gateway \
    --lorawan GatewayEui="a1b2c3d4567890ab",RfRegion="US915" \
    --name "myFirstLoRaWANGateway" \
    --description "Using my first LoRaWAN gateway"
    --cli-input-json file://input.json

Associate a certificate with your gateway

After you add your gateway to AWS IoT Wireless, it must be associated with a certificate to connect to the CUPS endpoint. To connect to the endpoint, your gateway running LoRa Basics Station requires the following files:

The following steps show you how to generate a certificate and associate it with your gateway.

Step 1: Generating a gateway certificate

To generate a certificate for your gateway, use the AWS IoT API Reference API action, CreateKeysAndCertificate, or the AWS CLI command, create-keys-and-certificate CLI command.

The following command shows an example of generating the certificate, cups.crt, and the private key, cups.key.

aws iot create-keys-and-certificate \ 
    --set-as-active --certificate-pem-outfile "cups.crt" \ 
    --private-key-outfile "cups.key"

Running this command generates the certificate and private key, and a certificate ID. The following example shows an output of running this command.

{
    "certificateArn": "arn:aws:iot:us-east-1:123456789012:cert/abc1234d55ef32101a34434bb123cba2a011b2cdefa6bb5cee1a221b4567ab12",
    "certificateId": "abc1234d55ef32101a34434bb123cba2a011b2cdefa6bb5cee1a221b4567ab12",
    "certificatePem": "-----BEGIN CERTIFICATE-----\n..\n-----END CERTIFICATE-----\n, 
          "KeyPair": { 
              "PublicKey": "-----BEGIN PUBLIC KEY -----\n..\n----END PUBLIC KEY----\n", 
              "PrivateKey": "----BEGIN RSA PRIVATE KEY----\n..\nEND RSA PRIVATE KEY----\n"
    }
}

Store the certificate ID temporarily, as it will be used in the subsequent step to associate your certificate with the gateway.

Step 2: Obtaining server trust certificate and CUPS endpoint

Now that you've generated the certificate and private key, use the GetServiceEndpoint API action or the get-service-endpoint CLI command to obtain the server trust certificate, cups.trust and the endpoint URI, cups.uri.

The following command shows an example of obtaining the server trust certificate and the endpoint URI. When running the command, set the service-type parameter to CUPS.

aws iotwireless get-service-endpoint --service-type CUPS

The following shows an output of running the command.

{
    "ServiceType": "CUPS",
    "ServiceEndpoint": "https://ABCDEFGHIJKLMN.cups.lorawan.us-east-1.amazonaws.com:443",
    "ServerTrust": "-----BEGIN CERTIFICATE-----\n..\n-----END CERTIFICATE-----\n"
}

The ServiceEndpoint obtained from the response corresponds to the CUPS endpoint, cups.uri.

Step 3: Associate the certificate with your gateway

You must associate the gateway's certificate that you generated with the gateway that you added. AWS IoT Core for LoRaWAN will use this information to identify the certificate that the gateway will use to connect to the CUPS endpoint.

To associate the certificate with your gateway, use the AssociateWirelessGatewaywithCertificate API action or the associate-wireless-gateway-with-certificate CLI command.

The following command shows an example of associating a certificate with your gateway.

aws iotwireless associate-wireless-gateway-with-certificate \
    --id <WirelessGatewayId> \
    --iot-certificate-id <CertificateId>

Running this command returns the IotCertificateId, which is the ID of the certificate that you associated with the gateway. The following shows an output of running the command, where the IotCertificateId is the ID of the certificate, such as abc1234d55ef32101a34434bb123cba2a011b2cdefa6bb5cee1a221b4567ab12.

{
    "IotCertificateId": "<CertificateId>"
}

Additional API operations

You can use the following API actions to perform the tasks associated with adding, updating, or deleting a LoRaWAN gateway.

For the complete list of the actions and data types available to create and manage AWS IoT Core for LoRaWAN resources, see the AWS IoT Wireless API reference.

For information about the CLIs that you can use, see AWS CLI reference.