Page Comparison

Note
This documentation is still in development - use at your own risk

This page explains how to create, configure, and manage gateways.

Creating or editing a gateway

You can create a gateway or edit an existing one using console, or gcloud. After you create a gateway, you can't change it to a non-gateway device. Make sure Ensure you've created a registry and a device key pair before completing the steps in this sectionbelow.

Console

...

Use the following methods to create or edit a gateway:

Device create method to add gateways to registries
Device patch method to edit existing gateways

C#Go Java Node.js Python Ruby

View on GitHub Feedback

...

Create a new gateway

1. Go to the Registries page. Click a registry ID.

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

3. Enter a gateway ID that 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 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 this gateway’s key pair. Paste the certificate or key in the Public key value field. You can also set the key’s expiration date.

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. Click Submit to create the gateway or Update to save changes to an existing gateway.

Edit 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 these methods to create or edit a gateway:

Device create method to add gateways to registries
Device patch method to edit existing gateways

Creating or editing a gateway code samples

Node.js

Code Block

// const cloudRegion = 'us-central1';
// const deviceId = 'my-unauth-device';
// const gatewayId = 'my-gateway';
// const projectId = 'adjective-noun-123';
// const registryId = 'my-registry';
// const gatewayAuthMethod = 'ASSOCIATION_ONLY';
import { DeviceManagerClient } from '@clearblade/iot';

const iotClient = new DeviceManagerClient({
  // optional auth parameters.
});

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

  console.log('Creating gateway:', gatewayId);

  let credentials = [];

  // if public key format and path are specified, use those
  if (publicKeyFormat && publicKeyFile) {
    credentials = [
      {
        KeypublicKey: = File.ReadAllText(publicKeyFilePath),{
          format:  publicKeyFormat,
          Formatkey: = (algorithm == "ES256" ?readFileSync(publicKeyFile).toString()
        }
       }
     ];
   }
 
  "ES256_PEM" : "RSA_X509_PEM")
 const device = {
     id:  gatewayId,
     credentials: }credentials,
    gatewayConfig: {
      gatewayType: 'GATEWAY',
  }     gatewayAuthMethod: gatewayAuthMethod
    }
    };

    Device createdDevice = cloudIoT.Projects.Locations.Registriesconst request = {
    parent: regPath,
    device
  };

  .Devices.Create(body, registryPath).Execute( const [response] = await iotClient.createDevice(request);
    Consoleconsole.WriteLinelog("'Created gateway: {0}", createdDevice.ToString());
    return 0;}

To learn how to create the devices you'll use with the gateway, see Creating or editing a device.

Configuring the gateway and getting state

With ClearBlade IoT Core, you can control a gateway by modifying its configuration, just as you would with any other device. See Configuring Devices to learn how to configure a gateway over the MQTT or HTTP bridge.

After a configuration has been applied to a gateway, the gateway can report its state to ClearBlade IoT Core. You can compare the gateway's state and its most recent configuration to make sure the gateway is doing what it's supposed to be doing.

Binding or unbinding a device

You can authenticate non-gateway devices to ClearBlade IoT Core by binding them to the gateway. Binding creates an association between the devices and the gateway that ClearBlade IoT Core checks to authenticate the devices.

Note: Binding is required when using the HTTP bridge.

Console gcloud API

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

Registries BindDeviceToGateway method to bind devices to gateways
Registries UnbindDeviceFromGateway method to unbind devices from gateways

C#Go Java Node.js Python Ruby

View on GitHub Feedback

Code Block

public static object BindDeviceToGateway(string projectId, string cloudRegion,
    string registryName, string deviceId, string gatewayId){
    CreateDevice(projectId, cloudRegion, registryName, deviceId);device:', response);
}

createDevice();

C#

Code Block

{
    logger.LogInformation("Create a new gateway");

    string id = "Sample-New-Gateway";
    string name = "projects/developmentenv/locations/us-central1/registries/Sample-New-Registry/Devices/Sample-New-Gateway";

    String keyText = File.ReadAllText("path/to/key");

    var credentials = new List<DeviceCredential>
    {
        new DeviceCredential()
        {
            PublicKey = new PublicKeyCredential()
            {
                Key = keyText,
                Format = "ES256_PEM"
            },
        }
    };

    var cloudIoTgatewayConfig = new CreateAuthorizedClientGatewayConfig();
    {
      var  registryPathGatewayType = $"projects/{projectId}GATEWAY",
+        GatewayAuthMethod  = $"/locations/{cloudRegion}"ASSOCIATION_ONLY"
+    };

    var   $"/registries/{registryName}";
    BindDeviceToGatewayRequest req = new BindDeviceToGatewayRequest
    {
        DeviceId = deviceId,
        GatewayId = gatewayId
    };

    var res = cloudIoT
        .Projects
        .Locations
        .Registries
        .BindDeviceToGateway(req, registryPath)
        .Execute();
    Console.WriteLine("Device bound: {0}", res.ToString());

    return 0;}

Listing all devices bound to a gateway

Console gcloud API

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

C#Go Java Node.js Python Ruby

View on GitHub Feedback

Code Block

public static object ListDevicesForGateways(string projectId,
 string cloudRegion, string registryName, string gatewayId){
    var cloudIoT = CreateAuthorizedClient();
    var gatewayPath = $"projects/{projectId}/locations/{cloudRegion}" +
        $"/registries/{registryName}/devices/{gatewayId}";
    var registryPath = $"projects/{projectId}/locations/{cloudRegion}" +
        $"/registries/{registryName}";
    var req = cloudIoT.Projects.Locations.Registries.Devices.List(registryPath);
    req.GatewayListOptionsAssociationsGatewayId = gatewayId;
    var devices = req.Execute().Devices;

    if (devices != null)
    {
        Console.WriteLine("Found {0} devices", devices.Count);
        foreach (var device in devices)
        {
            Console.WriteLine("ID: {0}", device.Id);
        }
    }result = await mClient.CreateDevice(4, id, name, credentials, gatewayConfig);
    if (!result.Item1 || (result.Item2 == null))
        logger.LogError("Failed to create new device");
    else
    {
        logger.LogInformation("Successfully created new device");

        // The result.Item2 object can be used to refer to newly created device
    }
}

Python

Code Block

import os
import io
from clearblade.cloud import iot_v1

def create_gateway():
  project_id = 'YOUR_PROJECT_ID'
  cloud_region = 'us-central1'
  registry_id = 'your-registry-id'
  device_id = 'your-device-id'
  gateway_id = 'your-gateway-id'
  public_key_file = 'path/to/ec_public.pem'
  algorithm = 'ES256'
  
  # Check that the gateway doesn't already exist
  exists = False
  client = iot_v1.DeviceManagerClient()

  parent = client.registry_path(project_id, cloud_region, registry_id)

  listDevicesRequest = iot_v1.ListDevicesRequest(parent=parent)
  devices = list(client.list_devices(request=listDevicesRequest))

  for device in devices:
    if device.id == gateway_id:
      exists = True
    print(
      "Device: {} : {} : {} : {}".format(
        device.id, device.num_id, device.config, device.gateway_config
      )
    )

  with io.open(public_key_file) as f:
    public_key = f.read()

  if algorithm == "ES256":
    public_key_format = iot_v1.PublicKeyFormat.ES256_PEM
  else:
    public_key_format = iot_v1.PublicKeyFormat.RSA_X509_PEM

  # TODO: Auth type
  gateway = iot_v1.Device(
    name=gateway_id,
    credentials=[{
      "publicKey": { "format": public_key_format, "key": public_key }
    }],
    gateway_config={
      "gatewayType": "GATEWAY",
      "gatewayAuthMethod": "ASSOCIATION_ONLY",
    }
  )

  if not exists:
    createDeviceRequest = iot_v1.CreateDeviceRequest(
      parent=parent,
      device=gateway
    )
    res = client.create_device(request=createDeviceRequest)
    print("Created Gateway {}".format(res))
  else:
    print("Gateway exists, skipping")

os.environ["CLEARBLADE_CONFIGURATION"] = "/path/to/your-credentials.json"
create_gateway()

Go

Code Block

// getDevice retrieves a specific device and prints its details.
func createGateway(w io.Writer, projectID string, region string, registryID string, gatewayID string, gatewayAuthMethod string, publicKeyPath string) (*iot.Device, error) {
    ctx := context.Background()
    service, err := iot.NewService(ctx)
    if err != nil {
        return nil, err
    }

    keyBytes, err := ioutil.ReadFile(publicKeyPath)
    if err != nil {
        return nil, err
    }

    gateway := &cloudiot.Device{
        Id: gatewayID,
        Credentials: []*cloudiot.DeviceCredential{
            {
                PublicKey: &cloudiot.PublicKeyCredential{
                    Format: "RSA_X509_PEM",
                    Key:    string(keyBytes),
                },
            },
        },
        GatewayConfig: &cloudiot.GatewayConfig{
            GatewayType:       "GATEWAY",
            GatewayAuthMethod: gatewayAuthMethod,
        },
    }

    parent := fmt.Sprintf("projects/%s/locations/%s/registries/%s", projectID, region, registryID)
    response, err := service.Projects.Locations.Registries.Devices.Create(parent, gateway).Do()
    if err != nil {
        return nil, err
    }

    fmt.Fprintln(w, "Successfully created gateway:", gatewayID)

    return response, nil
}

See Creating or editing a device to learn how to create the devices you'll use with the gateway.

Configuring the gateway and getting state

With ClearBlade IoT Core, you can control a gateway by modifying its configuration, like any other device. See Configuring devices to learn how to configure a gateway over the MQTT or HTTP bridge.

After a configuration has been applied to a gateway, the gateway can report its state to ClearBlade IoT Core. You can compare the gateway's state and its most recent configuration to ensure it’s functioning properly.

Binding or unbinding a device

You can authenticate non-gateway devices to ClearBlade IoT Core by binding them to the gateway. Binding creates an association between the devices and the gateway that ClearBlade IoT Core checks to authenticate the devices.

Binding is required when using the HTTP bridge.

Console

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 these methods to bind a device to or unbind a device from a gateway:

Registries BindDeviceToGateway method to bind devices to gateways
Registries UnbindDeviceFromGateway method to unbind devices from gateways

Binding a device to or unbinding a device from a gateway code samples

Node.js

Code Block

// const cloudRegion = 'us-central1';
// const deviceId = 'my-unauth-device';
// const gatewayId = 'my-gateway';
// const projectId = 'adjective-noun-123';
// const registryId = 'my-registry';
import { DeviceManagerClient } from '@clearblade/iot';

const iotClient = new DeviceManagerClient({
  // optional auth parameters.
});

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

  const bindRequest = {
    parent: regPath,
    deviceId: deviceId,
    gatewayId: gatewayId
  };

  console.log(`Binding device: ${deviceId}`);

  await iotClient.bindDeviceToGateway(bindRequest);

  console.log(`Bound ${deviceId} to`, gatewayId);
}

bindDeviceToGateway();

C#

Code Block

if (bBindUnBindDevice)
{
    logger.LogInformation("Get configuration of a device");

    // While running this sample, it is assumed that device with name
    // "Sample-New-Device" exists and Gateway with name "TestGateway" exists
    // "Sample-New-Registry" is the registry name

    // Sample - Bind Device
    var result = await mClient.BindDeviceToGateway(4, "projects/developmentenv/locations/us-central1/registries/Sample-New-Registry", "TestGateway", "Sample-New-Device");
    if (!result)
    {
        logger.LogError("Failed To Bind Device");
    }
    else
    {
        // Actual test - UnBind Device
        result = await mClient.UnBindDeviceFromGateway(4, "projects/developmentenv/locations/us-central1/registries/Sample-New-Registry", "TestGateway", "Sample-New-Device");
        if (!result)
            logger.LogError("Failed to unbind a device");
        else
            logger.LogInformation("Successfully bind device");

    }
}

Python

Code Block

import os
from clearblade.cloud import iot_v1

def bind_device_to_gateway():
  project_id = 'YOUR_PROJECT_ID'
  cloud_region = 'us-central1'
  registry_id = 'your-registry-id'
  device_id = 'your-device-id'
  gateway_id = 'your-gateway-id'
  client = iot_v1.DeviceManagerClient()

  parent = client.registry_path(project_id, cloud_region, registry_id)

  request = iot_v1.BindDeviceToGatewayRequest(
    parent=parent,
    gatewayId=gateway_id,
    deviceId=device_id
  )
  res = client.bind_device_to_gateway(request=request)

  print("Device Bound! {}".format(res))

os.environ["CLEARBLADE_CONFIGURATION"] = "/path/to/your-credentials.json"
bind_device_to_gateway()

Go

Code Block

// bindDeviceToGateway creates an association between an existing device and gateway.
func bindDeviceToGateway(w io.Writer, projectID string, region string, registryID string, gatewayID string, deviceID string) (*iot.BindDeviceToGatewayResponse, error) {
    ctx := context.Background()
    service, err := iot.NewService(ctx)

    if err != nil {
        return nil, err
    }
    parent := fmt.Sprintf("projects/%s/locations/%s/registries/%s", projectID, region, registryID)
    bindRequest := &iot.BindDeviceToGatewayRequest{
        DeviceId:  deviceID,
        GatewayId: gatewayID,
    }

    response, err := service.Projects.Locations.Registries.BindDeviceToGateway(parent, bindRequest).Do()

    if err != nil {
        return nil, fmt.Errorf("BindDeviceToGateway: %v", err)
    }

    if response.HTTPStatusCode/100 != 2 {
        return nil, fmt.Errorf("BindDeviceToGateway: HTTP status code not 2xx\n %v", response)
    }

    fmt.Fprintf(w, "Bound %s to %s", deviceID, gatewayID)

    return response, nil
}

Listing all devices bound to a gateway

Console

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.

Listing all devices bound to the gateway code samples

Node.js

Code Block

// const cloudRegion = 'us-central1';
// const gatewayId = 'my-gateway';
// 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 parentName = iotClient.registryPath(projectId, cloudRegion, registryId);
  const [response] = await iotClient.listDevices({
    parent: parentName,
    gatewayListOptions: { associationsGatewayId: gatewayId }
  });
  const devices = response;

  if (devices.length > 0) {
    console.log('Current devices bound to gateway: ', gatewayId);
  } else {
    console.log('No devices bound to this gateway.');
  }

  for (let i = 0; i < devices.length; i++) {
    const device = devices[i];
    console.log(`\tDevice: ${device.numId}: ${device.id}`);
  }
}

listDevices();

C#

Code Block

{
    logger.LogInformation("Obtain list of devices for a particular registry and gateway");

    // While running this sample, it is assumed that gateway with name
    // "associated-gateway" exists

    GatewayListOptionsModel gatewayListOptions = new GatewayListOptionsModel()
    {
        AssociationsGatewayId = "associated-gateway",
    };
    var result = await mClient.GetDevicesList(4, "projects/developmentenv/locations/us-central1/registries/Sample-New-Registry", gatewayListOptions);
    if (!result.Item1)
        logger.LogError("Failed to get list of devices");
    else
    {
        logger.LogInformation("Succeeded in getting the list of Devices");

        // Use the list
    }
}

Python

Code Block

import os
from clearblade.cloud import iot_v1

def list_bound_devices():
  project_id = 'YOUR_PROJECT_ID'
  cloud_region = 'us-central1'
  registry_id = 'your-registry-id'
  gateway_id = 'your-gateway-id'

  client = iot_v1.DeviceManagerClient()

  path = client.registry_path(project_id, cloud_region, registry_id)

  request = iot_v1.ListDevicesRequest(
    parent=path,
    gatewayListOptions={ "associationsGatewayId": gateway_id }
  )
  
  devices = list(client.list_devices(request=request))

  found = False
  for device in devices:
      found = True
      print("Device: {} : {}".format(device.num_id, device.id))

  if not found:
      print("No devices bound to gateway {}".format(gateway_id))

os.environ["CLEARBLADE_CONFIGURATION"] = "/path/to/your-credentials.json"
list_bound_devices()

Go

Code Block


// listDevicesForGateway lists the devices that are bound to a gateway.
func listDevicesForGateway(w io.Writer, projectID string, region string, registryID, gatewayID string) ([]*iot.Device, error) {
    // Authorize the client using Application Default Credentials.
    // See https://g.co/dv/identity/protocols/application-default-credentials
    ctx := context.Background()
    service, err := iot.NewService(ctx)
    if err != nil {
        return nil, err
    }
    parent := fmt.Sprintf("projects/%s/locations/%s/registries/%s", projectID, region, registryID)
    response, err := service.Projects.Locations.Registries.Devices.List(parent).GatewayListOptionsAssociationsGatewayId(gatewayID).Do()

    if err != nil {
        return nil, fmt.Errorf("ListDevicesForGateway: %v", err)
    }

    if len(response.Devices) == 0 {
        fmt.Fprintln(w, "\tNo devices found")
        return response.Devices, nil
    }

    fmt.Fprintf(w, "Devices for %s:\n", gatewayID)
    for _, gateway := range response.Devices {
        fmt.Fprintf(w, "\t%s\n", gateway.Id)
    }

    return response.Devices, nil
}

Listing all gateways in a registry

Console

1. Go to the Registries page.

2. Click a registry ID.

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

API

Use the device list method to list a registry’s gateways.

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();

C#

Code Block

{
    logger.LogInformation("Obtain list of gateways in a registry");

    GatewayListOptionsModel gatewayListOptions = new GatewayListOptionsModel()
    {
        GatewayType = core.Enums.GatewayTypeEnum.GATEWAY,
    };

    var result = await mClient.GetDevicesList(4, "projects/developmentenv/locations/us-central1/registries/Sample-New-Registry", gatewayListOptions);
    if (!result.Item1)
        logger.LogError("Failed to get list of devices");
    else
    {
        logger.LogInformation("Succeeded in getting the list of gateways");

        // Use the list
    }
}

Python

Code Block

import os
from clearblade.cloud import iot_v1

def list_gateways():
  project_id = 'YOUR_PROJECT_ID'
  cloud_region = 'us-central1'
  registry_id = 'your-registry-id'

  client = iot_v1.DeviceManagerClient()

  path = client.registry_path(project_id, cloud_region, registry_id)
  mask = "config,gateway_config"

  request = iot_v1.ListDevicesRequest(
    parent=path,
    # fieldMask=mask
  )
  
  devices = list(client.list_devices(request=request))

  for device in devices:
    print(device.id)
    if device.gateway_config is not None:
      print(f"gateway_config: {device.gateway_config}")
      if device.gateway_config['gatewayType'] == 1:
        print("Gateway ID: {}\n\t{}".format(device.id, device))

os.environ["CLEARBLADE_CONFIGURATION"] = "/path/to/your-credentials.json"
list_gateways()

Go

Code Block

// listGateways lists all the gateways in a specific registry.
func listGateways(w io.Writer, projectID string, region string, registryID string) ([]*iot.Device, error) {
    ctx := context.Background()
    service, err := iot.NewService(ctx)
    if err != nil {
        return nil, err
    }

    parent := fmt.Sprintf("projects/%s/locations/%s/registries/%s", projectID, region, registryID)
    response, err := service.Projects.Locations.Registries.Devices.List(parent).GatewayListOptionsGatewayType("GATEWAY").Do()

    if err != nil {
        return nil, fmt.Errorf("ListGateways: %v", err)
    }

    if len(response.Devices) == 0 {
        fmt.Fprintln(w, "No gateways found")
        return response.Devices, nil
    }

    fmt.Fprintln(w, len(response.Devices), "devices:")
    for _, gateway := range response.Devices {
        fmt.Fprintf(w, "\t%s\n", gateway.Id)
    }

    return response.Devices, nil
}

Deleting devices bound to a gateway

To delete a device bound to a gateway, you first unbind the device from all gateways it's bound to, then delete it from the registry.

Console

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

2. In the Device details page, click Delete.

API

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

Deleting a device bound to a gateway 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 deleteDevice() {
  // Construct request
  const devPath = iotClient.devicePath(projectId, cloudRegion, registryId, deviceId);

  const [responses] = await iotClient.deleteDevice({ name: devPath });
  console.log('Successfully deleted device', responses);
}

deleteDevice();

C#

Code Block

{
    logger.LogInformation("Unbind the device");

    var unbindResult = await mClient.UnBindDeviceFromGateway(4, "projects/developmentenv/locations/us-central1/registries/Sample-New-Registry", "TestGateway", "Sample-New-Device");
    if (!unbindResult)
        logger.LogError("Failed to unbind a device");
    else
        logger.LogInformation("Successfully unbind device");

    logger.LogInformation("Delete the device");

    string id = "Sample-New-Device";
    string name = "projects/developmentenv/locations/us-central1/registries/Sample-New-Registry/Devices/Sample-New-Device";

    var deleteResult = await mClient.DeleteDevice(4, id, name);
    if (!deleteResult.Item1 || (deleteResult.Item2 == null))
        logger.LogError("Failed to delete device");
    else
    {
        Consolelogger.WriteLineLogInformation("GatewaySuccessfully hasdeleted no bound devices.the device");
    }

   
return 0;}

Listing all gateways in a registry

Console gcloud API

...

Python

...

Code Block

public static object ListGateways(string projectId, string cloudRegion, string registryName){
    var cloudIoT = CreateAuthorizedClient();
    var registryPath = $"projects/{projectId}/locations/{cloudRegion}/registries/{registryName}";

    var req = cloudIoT
        .Projects
        .Locations
        .Registries
        .Devices
        .List(registryPath);
    req.FieldMask = "config,gatewayConfig";

    var devices = req.Execute().Devices;

    if (devices != null)
    {
        Console.WriteLine("Found {0} devices", devices.Count);
        devices.ToList().ForEach(device =>
           {
               if (device.GatewayConfig != nullimport os
from clearblade.cloud import iot_v1

def delete_device():
  project_id = 'YOUR_PROJECT_ID'
  cloud_region = 'us-central1'
  registry_id = 'your-registry-id'
  device_id = 'your-device-id'
  
  print("Delete device")
  client = iot_v1.DeviceManagerClient()

  device_path = client.device_path(project_id, cloud_region, registry_id, device_id)

  request = iot_v1.DeleteDeviceRequest(name=device_path)

  return client.delete_device(request=request)

os.environ["CLEARBLADE_CONFIGURATION"] = "/path/to/your-credentials.json"
delete_device()

Go

Code Block

// deleteDevice deletes a device from a registry.
func deleteDevice(w io.Writer, projectID string, region string, registryID string, deviceID string) (*iot.Empty, error) {
    ctx := context.Background()
    service, err := iot.NewService(ctx)
    if err != nil {
        return nil, err
    }

   && device.GatewayConfig.GatewayType != null
        path := fmt.Sprintf("projects/%s/locations/%s/registries/%s/devices/%s", projectID, region, registryID, deviceID)
     response,  err   && device.GatewayConfig.GatewayType.Equals("GATEWAY"):= service.Projects.Locations.Registries.Devices.Delete(path).Do()
        if err != nil {
       {  return  nil,  err
     }
 
     Consolefmt.WriteLineFprintf(w, "IdDeleted :{0}device: %s\n", device.IddeviceID);
 
     return  response,          if (device.Config != null)
                   {
                       Console.WriteLine("Config: {0}", device.Config.ToString());
                   }
               }
           }
        );
    }
    else
    {
        Console.WriteLine("Registry has no gateway devices");
    }

    return 0;}

Deleting devices bound to a gateway

To delete a device bound to a gateway, you first unbind the device from all gateways it's bound to, then delete the device from the registry.

Console gcloud API

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

C#Go Java Node.js Python Ruby

View on GitHub Feedback

Code Block

public static object DeleteDevice(string projectId, string cloudRegion, string registryId, string deviceId){
    var cloudIoT = CreateAuthorizedClient();
    // The resource name of the location associated with the key rings.
    var name = $"projects/{projectId}/locations/{cloudRegion}/registries/{registryId}/devices/{deviceId}";

    try
    {
        var res = cloudIoT.Projects.Locations.Registries.Devices.Delete(name).Execute();nil
}

Deleting a gateway

To delete a gateway, you first unbind its devices and then delete the gateway from the registry.

Console

1. Unbind all devices from the gateway.

2. Go back to the Gateway details page and 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.

Deleting a gateway 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 deleteDevice() {
  // Construct request
  const devPath = iotClient.devicePath(projectId, cloudRegion, registryId, deviceId);

  const [responses] = await iotClient.deleteDevice({ name: devPath });
  console.log('Successfully deleted device', responses);
}

deleteDevice();

C#

Code Block

{
    logger.LogInformation("Unbind the device");

    var unbindResult = await mClient.UnBindDeviceFromGateway(4, "projects/developmentenv/locations/us-central1/registries/Sample-New-Registry", "TestGateway", "Sample-New-Device");
    if (!unbindResult)
        logger.LogError("Failed to unbind a device");
    else
        logger.LogInformation("Successfully unbind device");

    logger.LogInformation("Delete the device");

    string id = "Sample-New-Device";
    string name = "projects/developmentenv/locations/us-central1/registries/Sample-New-Registry/Devices/Sample-New-Device";

    var deleteResult = await mClient.DeleteDevice(4, id, name);
    if (!deleteResult.Item1 || (deleteResult.Item2 == null))
        Consolelogger.WriteLineLogError($"RemovedFailed to delete device: {deviceId}");
    }
    catch (Google.GoogleApiException e)else
    {
        Consolelogger.WriteLine(e.MessageLogInformation("Successfully deleted the device");
        if (e.Error != null) return e.Error.Code;
        return -1;
    }
    return 0;}

Deleting a gateway

To delete a gateway, you first unbind its devices then delete the gateway from the registry.

Console gcloud API

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

C#Go Java Node.js Python Ruby

View on GitHub Feedback

Code Block

public static object DeleteDevice(string projectId, string cloudRegion, string registryId, string deviceId){
    var cloudIoT = CreateAuthorizedClient();
    // The resource name of the location associated with the key rings.
    var name = $"projects/{projectId}/locations/{cloudRegion}/registries/{registryId}/devices/{deviceId}";

    try
    {
        var res = cloudIoT.Projects.Locations.Registries.Devices.Delete(name).Execute();
        Console.WriteLine($"Removed device: {deviceId}");
    }
    catch (Google.GoogleApiException e)
    {
        Console.WriteLine(e.Message);
        if (e.Error != null) return e.Error.Code;}
}

Python

Code Block

import os
from clearblade.cloud import iot_v1

def delete_gateway():
  project_id = 'YOUR_PROJECT_ID'
  cloud_region = 'us-central1'
  registry_id = 'your-registry-id'
  gateway_id = 'your-gateway-id'
  
  print("Delete gateway")
  client = iot_v1.DeviceManagerClient()

  device_path = client.device_path(project_id, cloud_region, registry_id, gateway_id)

  request = iot_v1.DeleteDeviceRequest(name=device_path)

  return client.delete_device(request=request)

os.environ["CLEARBLADE_CONFIGURATION"] = "/path/to/your-credentials.json"
delete_gateway()

Go

Code Block

// deleteDevice deletes a device from a registry.
func deleteDevice(w io.Writer, projectID string, region string, registryID string, deviceID string) (*iot.Empty, error) {
    ctx := context.Background()
    service, err := iot.NewService(ctx)
    if err != nil {
        return nil, err
    }

    path := fmt.Sprintf("projects/%s/locations/%s/registries/%s/devices/%s", projectID, region, registryID, deviceID)
    response, err := service.Projects.Locations.Registries.Devices.Delete(path).Do()
    if err != nil {
        return -1; nil, err
    }

    fmt.Fprintf(w, "Deleted device: %s\n", deviceID)

    return 0; response, nil
}

What's next

Use the MQTT or HTTP bridge to relay messages and configuration data between the devices and ClearBlade IoT CoreReview the Cloud IoT Core quotas and limits.

Page Comparison

Versions Compared

Old Version 4

New Version Current

Key

Creating or editing a gateway

Console

Create a new gateway

Edit an existing gateway

API

Creating or editing a gateway code samples

Node.js

Configuring the gateway and getting state

Binding or unbinding a device

C#

Listing all devices bound to a gateway

Python

Go

Configuring the gateway and getting state

Binding or unbinding a device

Console

API

Binding a device to or unbinding a device from a gateway code samples

Node.js

C#

Python

Go

Listing all devices bound to a gateway

Console

API

Listing all devices bound to the gateway code samples

Node.js

C#

Python

Go

Listing all gateways in a registry

Console

API

Listing a registry’s gateways code samples

Node.js

C#

Python

Go

Deleting devices bound to a gateway

Console

API

Deleting a device bound to a gateway code samples

Node.js

C#

Listing all gateways in a registry

Python

Go

Deleting devices bound to a gateway

Deleting a gateway

Console

API

Deleting a gateway code samples

Node.js

C#

Deleting a gateway

Python

Go

What's next