Device library

Starting in Maximo® Monitor 9.0, you can add devices to Maximo Monitor by using the device library. The library contains hundreds of manufacturer-specific devices and default metrics and dimensions. You can choose the device that you want to add, configure its unique settings, and then select the metrics that you want to the device to use. You connect your associated physical devices to Maximo Monitor by using a Managed gateway.

Devices

For a complete list of devices, see the device library search. To submit a request for a new device or manufacturer, use the IBM Ideas Portal.

You can also add PLC or OPC UA devices from certain manufacturers to the library. For more information, see Adding PLC, OPC UA, and custom devices to the device library.

Hardware and software requirements

When you add devices from the library, you must associate the devices with a Managed gateway in Maximo Monitor. The Managed gateway might represent a physical gateway or an edge device. After you add the devices to Maximo Monitor and the gateway, you deploy the Edge Data Collector container image on that gateway or edge device.

The container image is cross-compiled to run on many hardware platforms. At minimum, the physical edge device or gateway must have the following specifications:

  • 512 MB of disk space

    When the Edge Data Collector container image is deployed on Intel Corporation systems, the image uses approximately 26 MB of disk space.

  • 2 GB of RAM
  • Ethernet or serial ports

The required runtime RAM and processor volume depend on the number of connected devices and clients. For example, if you run 10 devices and use an OPC UA server, the container image uses approximately 5 MB of RAM.

The gateway or edge device must have the following software:

Table 1. Software requirements
Software Details
Operating system You can run the container image on any operating system that can also run Linux® and Docker.
Docker Use Docker 19 or later.

Docker commands

The Edge Data Collector container image command line interface (CLI) includes multiple subcommands.

Each subcommand includes a help section. To view the help section, run the edgedatacollector <subcommand> command. For example, the following content is the help section for the launch subcommand:
Start data collection with the Edge Data Collector container image

Usage: edge launch [OPTIONS]

Options:
  -d, --debug                           
      --disconnect-after-query          Close the connection after reading from or writing to a device. The connection will be reestablished on the next read/write
      --http-proxy <PROXY>              Use the given URL as a proxy for all API requests
      --id <INST_ID>                    ID of the integration
  -t, --token <TOKEN>                   Access token required to fetch the integration
  -p, --package <PKG>                   The EDC package to launch with (for offline setups)
      --use-device-label-as-mqtt-topic  Use device label as MQTT topic
      --use-device-label-in-opcua-dirs  use device label in OPC-UA dirs
      --add-certificate <ROOT_CERTS>    Root certificate required to fetch the integration
  -h, --help                            Print help
  -V, --version                         Print version

To verify that the Docker image is running, run the $ docker run --rm -it icr.io/cpopen/ibm-mas/edgedatacollector command.

To retrieve the latest version of the Docker image, run the $ docker pull icr.io/cpopen/ibm-mas/edgedatacollector command.

The following text is an example of the latest version information:
Usage: edge [OPTIONS] <COMMAND>

Commands:
  launch       Start data collection 
  save         Save an integration locally for use in offline mode
  discover     Discovers devices of a particular protocol
  scandevice   Scan a given device for available data points
  remote-test  Collect logs for remote testing
  help         Print this message or the help of the given subcommand(s)

Options:
  -d, --debug               
      --http-proxy <PROXY>  Use the given URL as a proxy for all API requests
  -h, --help                Print help
  -V, --version             Print version

To stop the Docker image, run the $ docker stop <container_ID> command.