Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

After you create a gateway, you can't change it to a non-gateway device. Ensure you've created a registry and a device key pair before completing the steps in this sectionbelow.

Console

To create a new gateway:

  1. Go to the Google Cloud console’s Registries page in the Google Cloud console.

    Click the gateway’s registry ID.

  2. On the Registry details page, click Gateways and Add gateway to create a new gateway.

  3. Enter a Gateway ID that briefly describes the gateway and helps you identify it (this field can't be edited later).

  4. For Gateway communication, select Allow or Block. The latter allows you to block communication when needed, such as when a gateway or one or more devices bound to it are not functioning properly. You’ll most likely want to allow communication when first creating the gateway. When a gateway is blocked, all devices bound to it are blocked from communicating with ClearBlade IoT Core.

  5. Select the Public key format that matches the this gateway’s key pair for this gateway. Paste the certificate or key in the Public key value field. You can also set an the key’s expiration date for the key.

  6. Select the authentication method to use for devices bound to the gateway.

  7. Use the Key and Value fields to add optional gateway metadata, such as a serial number.

  8. Under Stackdriver Logging, select an the gateway’s activity log level for the gateway. The gateway's log level overrides its registry's log level.

  9. Click Create to create the gateway or Update to save changes to an existing gateway.

...

  1. Go to the Registries page.

  2. Click the gateway’s registry ID.

  3. Click Registry details.

  4. Click Gateways.

  5. Click the gateway’s ID you want to edit.

  6. Click Edit at the top of the page.

To add a key to an existing gateway, click Add public key on the Device details page.

API

Use the following methods to create or edit a gateway:

...

  1. Go to the Registries page.

  2. Click the gateway’s registry ID.

  3. Click Gateways, then click the gateway's ID.

  4. On the Gateway details page, click Bound devices.

  5. Click Bind device.

  6. Select the devices you want to bind to the gateway, then click Bind.

  7. To unbind a device, select the device in the Gateway details page, and click Unbind device and Unbind to confirm.

API

Use the following methods to bind a device to or unbind a device from a gateway:

...

  1. Go to the Registries page.

    Click the gateway’s registry ID.

  2. Click Gateways, then click the gateway's ID.

  3. On the Gateway details page, click Bound devices.

API

Use the Devices list method and specify a gateway ID to list all devices bound to the gateway.

...

  1. Go to the Registries page.

  2. Click the gateway’s registry ID.

  3. On the Registry details page, click Gateways to see a list of the registry’s gateways.

...

Use the Device list method to list all a registry’s gateways in a registry.

Listing

...

a registry’s gateways

...

code samples

Node.js
Code Block
// const cloudRegion = 'us-central1';
// const projectId = 'adjective-noun-123';
// const registryId = 'my-registry';
import { DeviceManagerClient } from '@clearblade/iot';
const iotClient = new DeviceManagerClient({
  // optional auth parameters.
});

async function listDevices() {
  // Construct request
  const registryPath = iotClient.registryPath(projectId, cloudRegion, registryId);

  console.log('Current gateways in registry:');
  const [response] = await iotClient.listDevices({
    parent: registryPath,
    fieldMask: { paths: ['config', 'gateway_config'] },
    gatewayListOptions: {
      gatewayType: 'GATEWAY'
    }
  });
  const devices = response;

  devices.forEach((device) => {
    console.log('----\n', device);
  });
}

listDevices();

...

  1. Unbind the device from every gateway it's bound to.

  2. In the Device details page, click Delete.

  3. Enter the device ID to confirm and click Delete.

API

After unbinding the device from all gateways it's bound to, use the Device delete method to delete the device.

...

  1. Unbind all devices from the gateway.

  2. Go back to the Gateway details page and click Delete.

  3. Enter the gateway's name to confirm, then click Delete.

API

After unbinding all devices from the gateway, use the Device delete method to delete the gateway, specifying the gateway’s ID you want to delete.

...