devices - IoT Agent command

This command allows you to list, create, update and delete device entry for IoT Agent.

• List all devices
• Create a device
• Get a device
• Update a device
• Delete a device

Common Options

Options	Description
--host VALUE, -h VALUE	broker or server host VALUE (required)
--service VALUE, -s VALUE	FIWARE Service VALUE
--path VALUE, -p VALUE	FIWARE ServicePath VALUE
--help	show help (default: true)

List all devices

This command lists all devices.

ngsi devices [command options] list [options]

Options

Options	Description
--host VALUE, -h VALUE	broker or server host VALUE (required)
--service VALUE, -s VALUE	FIWARE Service VALUE
--path VALUE, -p VALUE	FIWARE ServicePath VALUE
--limit VALUE	maximum number of devices
--offset VALUE	offset to skip a given number of elements at the beginning
--detailed VALUE	all device information (on) or only name (off)
--entity VALUE	get a device from entity name
--protocol VALUE	get devices with this protocol
--pretty, -P	pretty format (default: false)
--help	show help (default: true)

Examples

Request:

ngsi devices list --pretty

{
  "count": 1,
  "devices": [
    {
      "device_id": "sensor001",
      "service": "openiot",
      "service_path": "/",
      "entity_name": "urn:ngsi-ld:WeatherObserved:sensor001",
      "entity_type": "Sensor",
      "transport": "HTTP",
      "attributes": [
        {
          "object_id": "d",
          "name": "dateObserved",
          "type": "DateTime"
        },
        {
          "object_id": "t",
          "name": "temperature",
          "type": "Number"
        },
        {
          "object_id": "h",
          "name": "relativeHumidity",
          "type": "Number"
        },
        {
          "object_id": "p",
          "name": "atmosphericPressure",
          "type": "Number"
        }
      ],
      "lazy": [],
      "commands": [],
      "static_attributes": [
        {
          "name": "location",
          "type": "geo:json",
          "value": {
            "type": "Point",
            "coordinates": [
              139.7671,
              35.68117
            ]
          }
        }
      ],
      "explicitAttrs": false
    }
  ]
}

Create a device

This command creates a device.

ngsi devices [command options] create [options]

Options

Options	Description
--host VALUE, -h VALUE	broker or server host VALUE (required)
--service VALUE, -s VALUE	FIWARE Service VALUE
--path VALUE, -p VALUE	FIWARE ServicePath VALUE
--data VALUE	data body (payload) (required)
--help	show help (default: true)

Examples

Request:

ngsi devices create --data \
'{
 "devices": [
   {
     "device_id":   "sensor001",
     "entity_name": "urn:ngsi-ld:WeatherObserved:sensor001",
     "entity_type": "Sensor",
     "timezone":    "Asia/Tokyo",
     "attributes": [
       { "object_id": "d", "name": "dateObserved", "type": "DateTime" },
       { "object_id": "t", "name": "temperature", "type": "Number" },
       { "object_id": "h", "name": "relativeHumidity", "type": "Number" },
       { "object_id": "p", "name": "atmosphericPressure", "type": "Number" }
     ],
     "static_attributes": [
       { "name":"location", "type": "geo:json", "value" : { "type": "Point", "coordinates" : [ 139.7671, 35.68117 ] } }
     ]
   }
 ]
}'

Get a device

This command gets a device.

ngsi devices [command options] get [options]

Options

Options	Description
--host VALUE, -h VALUE	broker or server host VALUE (required)
--service VALUE, -s VALUE	FIWARE Service VALUE
--path VALUE, -p VALUE	FIWARE ServicePath VALUE
--id VALUE	device id (required)
--pretty, -P	pretty format (default: false)
--help	show help (default: true)

Examples

Request:

ngsi devices get --id sensor001 --pretty

{
  "device_id": "sensor001",
  "service": "openiot",
  "service_path": "/",
  "entity_name": "urn:ngsi-ld:WeatherObserved:sensor001",
  "entity_type": "Sensor",
  "transport": "HTTP",
  "attributes": [
    {
      "object_id": "d",
      "name": "dateObserved",
      "type": "DateTime"
    },
    {
      "object_id": "t",
      "name": "temperature",
      "type": "Number"
    },
    {
      "object_id": "h",
      "name": "relativeHumidity",
      "type": "Number"
    },
    {
      "object_id": "p",
      "name": "atmosphericPressure",
      "type": "Number"
    }
  ],
  "lazy": [],
  "commands": [],
  "static_attributes": [
    {
      "name": "location",
      "type": "geo:json",
      "value": {
        "type": "Point",
        "coordinates": [
          139.7671,
          35.68117
        ]
      }
    }
  ],
  "explicitAttrs": false
}

Update a device

This command updates a device.

ngsi devices [command options] update [options]

Options

Options	Description
--host VALUE, -h VALUE	broker or server host VALUE (required)
--service VALUE, -s VALUE	FIWARE Service VALUE
--path VALUE, -p VALUE	FIWARE ServicePath VALUE
--id VALUE	device id (required)
--data VALUE	data body (payload) (required)
--help	show help (default: true)

Examples

Request:

ngsi devices update \
--id sensor003 \
--data '{"entity_name": "urn:ngsi-ld:WeatherObserved:sensor333"}'

Delete a device

This command deletes a device.

ngsi devices [command options] delete [options]

Options

Options	Description
--host VALUE, -h VALUE	broker or server host VALUE (required)
--service VALUE, -s VALUE	FIWARE Service VALUE
--path VALUE, -p VALUE	FIWARE ServicePath VALUE
--id VALUE	device id (required)
--help	show help (default: true)

Examples

Request:

ngsi devices delete --id sensor001