Device Info

Device Info

This Datastream module enable to register the datastreams to provide the information of the device. This means that each device will have its own module Device Info.

There are this devices info modules for now:

Dependencies

This module have no dependencies.

Configuration

To configure Device Info module, a file named es.amplia.oda.datastreams.deviceinfo.cfg (or deviceinfofx30, or deviceinfoowa450) must be created with the next parameters for each input channel that you want to register:

  • deviceId: (null if not specified). Identifier of the device. This parameter is used by the third-system (OpenGate, Scada…) to identify where the data arrive from.

  • apiKey: (Required parameter). API Key (like a pass) to access to the third-system.

  • source: (Required parameter). Directory where the bundles (.jar’s) are installed.

  • path: (Required parameter). Directory where the script of the Device Info are installed. These files will be executed on runtime to collect the information.

  • scripts: List of scripts to execute to get information about device and its datastreamId associated with the format:

      <datastreamId>=<path_to_script>;<data_type>
    

es.amplia.oda.datastreams.deviceinfo*.cfg will have a similar format to:

# Device identifier. If not provided the serial number is used
deviceId=testDevice
# API Key to connect to OpenGate
apiKey=testApiKey
# Directory to get the scripts
source=deploy
# Directory to extract the scripts
path=scripts

# List of datastreamId and script to execute for this datastreamId
# <datastreamId>=<path_to_script>;<data_type>
# <data_type> can be STRING, LONG, INTEGER, BOOLEAN, FLOAT, DOUBLE. If is not specified STRING type will be used
device.clock=scripts/obtainClock.sh
device.upTime=scripts/obtainUptime.sh;LONG
device.cpu.total=scripts/obtainCpuTotal.sh;INTEGER
device.cpu.status=scripts/obtainCpuStatus.sh;
device.cpu.usage=scripts/obtainCpuUsage.sh;INTEGER
device.ram.total=scripts/obtainRamTotal.sh;LONG
device.ram.usage=scripts/obtainRamUsage.sh;INTEGER
device.storage.disk.total=scripts/obtainDiskTotal.sh;LONG
device.storage.disk.usage=scripts/obtainDiskUsage.sh;INTEGER
device.temperature.status=scripts/obtainTemperatureStatus.sh
device.temperature.value=scripts/obtainTemperatureValue.sh;INTEGER
device.serialNumber=scripts/obtainSerialNumber.sh