This documentation is still in development - use at your own risk
Creating or editing a gateway
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 section.
Console
To create a new gateway:
Go to the Registries page in the Google Cloud console.
Click the ID of the registry for the gateway.
On the Registry details page, click Gateways and Add gateway to create a new gateway.
Enter a Gateway ID that briefly describes the gateway and helps you identify it (this field can't be edited later).
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.
Select the Public key format that matches the key pair for this gateway. Paste the certificate or key in the Public key value field. You can also set an expiration date for the key.
Select the authentication method to use for devices bound to the gateway.
Use the Key and Value fields to add optional gateway metadata, such as a serial number.
Under Stackdriver Logging, select an activity log level for the gateway. The gateway's log level overrides its registry's log level.
Click Create to create the gateway or Update to save changes to an existing gateway.
To edit an existing gateway:
Go to the Registries page.
Click the ID of the registry for the gateway.
Click Registry details.
Click Gateways.
Click the ID of the gateway you want to edit.
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:
Creating or editing a gateway code samples
Node.js
// 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 = [
{
publicKey: {
format: publicKeyFormat,
key: readFileSync(publicKeyFile).toString()
}
}
];
}
const device = {
id: gatewayId,
credentials: credentials,
gatewayConfig: {
gatewayType: 'GATEWAY',
gatewayAuthMethod: gatewayAuthMethod
}
};
const request = {
parent: regPath,
device
};
const [response] = await iotClient.createDevice(request);
console.log('Created device:', response);
}
createDevice();
C#
{
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 gatewayConfig = new GatewayConfig()
{
GatewayType = "GATEWAY",
GatewayAuthMethod = "ASSOCIATION_ONLY"
};
var 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
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()
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.
Note: Binding is required when using the HTTP bridge.
Console
Go to the Registries page.
Click the ID of the registry for the gateway.
Click Gateways, then click the gateway's ID.
On the Gateway details page, click Bound devices.
Click Bind device.
Select the devices you want to bind to the gateway, then click Bind.
To unbind a device, select the device in the Gateway details page, click Unbind device and Unbind to confirm.
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
Binding a device to or unbinding a device from a gateway code samples
Node.js
// 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#
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
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()
Listing all devices bound to a gateway
Console
Go to the Registries page.
Click the ID of the registry for the gateway.
Click Gateways, then click the gateway's ID.
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
// 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#
{
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
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()
Listing all gateways in a registry
Console
Go to the Registries page.
Click the ID of the registry for the gateway.
On the Registry details page, click Gateways to see a list of all gateways in that registry.
API
Use the Device list method to list all gateways in a registry.
Listing all gateways in a registry code samples
Node.js
// 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#
{
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
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()
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
Unbind the device from every gateway it's bound to.
In the Device details page, click Delete.
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.
Deleting a device bound to a gateway code samples
Node.js
// 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#
{
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
{
logger.LogInformation("Successfully deleted the device");
}
}
Python
import 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()
Deleting a gateway
To delete a gateway, you first unbind its devices and then delete the gateway from the registry.
Console
Go back to the Gateway details page and click Delete.
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 ID of the gateway you want to delete.
Deleting a gateway code samples
Node.js
// 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#
{
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
{
logger.LogInformation("Successfully deleted the device");
}
}
Python
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()