Corvina IOT util

corvina-iot-util is a utility for corvina iot developers

USAGE:

corvina-iot-util [global options] command [command options]

COMMANDS

create-device-example: Create and run a device

• --model string: The JSON file containing the model configuration
• --activation-key string: The activation key of the device
• --device-dir string: The directory where the device will be created
• --host string: The hostname of the corvina iot server
• --start-device: If true, the device will be started after creation

npx @corvina/corvina-iot-util create-device-example \
 --model=model.json \
 --activation-key=XXXX-XXXX-XXX-XXX \
 --host=corvina.mk

insert-device-data: Insert bulk data into a device.

• --XApiKey string: specify a valide user API key
• --file string: specify the path of the file with the data to be inserted
• --host string: specify the corvina host. e.g.: corvina.mk
• --org string: specify a organization name. e.g.: exor
• --device-id string: (optional) specify the device id to override the one in the file
• --model-prefix string: (optional) specify the model name to override the one in the file

You can insert bulk data into a device using a JSON or CSV file.

Example JSON Data Insertion

npx @corvina/corvina-iot-util insert-device-data \
  --XApiKey=<api-key> \
  --org=<org> \
  --host=corvina.cloud \
  --file=./<file-name-data-json>

  {
    "deviceId": "i05Ofzkn35iSqrEch5lqCg",
    "modelPath": "Model:1/Property1",
    "header": [
      "timestamp",
      "value"
    ],
    "types": [
      "datetime",
      "integer"
    ],
    "data": [
      ["2024-11-06T12:53:36.000+01:00", 1 ],
      ["2024-11-06T12:53:50.000+01:00", 2 ],
    ]
  },
  {
    "deviceId": "i05Ofzkn35iSqrEch5lqCg",
    "modelPath": "Model:1/Property2",
    "header": [
      "timestamp",
      "value"
    ],
    "types": [
      "datetime",
      "integer"
    ],
    "data": [
      ["2024-11-06T12:53:36.000+01:00", 10 ],
      ["2024-11-06T12:53:50.000+01:00", 20 ],
    ]
  }
]

Example JSON Data Insertion

When using CSV data, it is recommended to set the --device-id and --model-prefix options to override these fields for all rows, ensuring consistency and simplifying the CSV structure.

Example CSV format:

deviceId,modelPath,timestamp,value
i05Ofzkn35iSqrEch5lqCg,Model:1/Property1,2024-11-06T12:53:36.000+01:00,1
i05Ofzkn35iSqrEch5lqCg,Model:1/Property1,2024-11-06T12:53:50.000+01:00,2
i05Ofzkn35iSqrEch5lqCg,Model:1/Property2,2024-11-06T12:53:36.000+01:00,10
i05Ofzkn35iSqrEch5lqCg,Model:1/Property2,2024-11-06T12:53:50.000+01:00,20

Usage:

npx @corvina/corvina-iot-util insert-device-data \
  --XApiKey=<api-key> \
  --org=<org> \
  --host=corvina.cloud \
  --file=./<file-name-data.csv> \
  --device-id=<device-id> \
  --model-prefix=<model-prefix>