Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 12 Next »

Use these descriptions and procedures to add a model to a project:

What is a Model in LoopCloud?

Before you can add a Device to a Project in LoopCloud, Device Models must be created. Models are specific to a project. 

A device model must be created to initiate a communication channel for the device to connect to LoopCloud with specific protocol parameter settings. Standard protocols include: HTTP, HTTPS, MQTT, MQTTS, LWM2M, LWM2M with DTLS. In addition, custom data blocks can be configured. Additional protocol descriptions can be found in:

When you configure a model, choose from a predefined set. A JSON file with configuration parameters can be downloaded and this file can be used to set up your device. You can also supply parameters, if your device requires additional key-value pairs.

A model cannot be deleted if it is being used by a device. The device must be deleted before the model can be removed.

Model Types

The following types are supported in LoopCloud.

LOOPEDGE: This model supports LoopEdge devices to connect to LoopCloud. It is similar to the embedded model, but with additional LoopEdge integration features, such as remote access and cloud activation.

EMBEDDED: An embedded system is a special-purpose system in which the computer is completely encapsulated by the device it controls, for example, a Raspberry Pi or an Arduino board. This model can be used for any such device or even a script that can use protocols supported by LoopCloud to send data and receive management commands.

POLL: Use this model for continuously polling a device. Some legacy systems allow collection of data from their devices using an http interface (SOAP or REST). LoopCloud’s poll model provides a way to integrate legacy systems or devices that are not able to send data; the poll model enables LoopCloud to pull data from those legacy devices. Another use case is web services. For example, Nest provides a web service that allows retrieval of data from their thermostats. In this case, there is no direct connection to a real device, but LoopCloud can collect data from the Nest sensors. Other examples include electric vehicle charging stations or even smart cars.

WEBHOOK: A webhook, often referred to as an HTTP callback, enables LoopCloud to push data to web applications. See Webhook Model. Once a device is deployed from a model, the webhook will be available at an address with the following format:{projectId}/{deviceId

Create a Model for a Project

Several options can be chosen when creating a model. For the purpose of this example, the steps cover a basic configuration.

To create a model:

  1. Click the company name at the top of the LoopCloud window.
  2. Click a Project.
  3. In the navigation panel, select Configuration > Models.
  4. Select the LOOPEDGE tab. See also, Model Types.
  5. Click New Model.
  6. In the Device Model Editor, select the CONFIG tab.
  7. Enter a Model Name.
  8. Click a checkbox from the Predefined Sets list to select a model and view its JSON code.
  9. Click Save.


This example shows the JSON code for the MQTT TLS/SSL connection parameters selection.

  "mqttHostName": "%MQTT_HOST%",
  "mqttSslPort": "%MQTT_SSL_PORT%",
  "mqttServerCA": "%MQTT_CA_CERT%",
  "mqttUserName": "%MQTT_USERNAME%",
  "mqttPassword": "%MQTT_PASSWORD%",
  "mqttClientId": "%MQTT_CLIENT_ID%",
  "mqttReqTopicName": "%MQTT_REQ_TOPIC%",
  "mqttRespTopicName": "%MQTT_RESP_TOPIC%",
  "mqttDataTopicName": "%MQTT_DATA_TOPIC%"

Change the Model Image

To easily identify a device's model, a specific graphics file, such as a vendor's image, can be uploaded and inserted into the project's model. Standard image formats, such as jpg and gif, are supported.

Generic Model Image

To change a model's image:

  1. Click the company name at the top of the LoopCloud window.
  2. Click a Project.
  3. In the navigation panel, select Configuration > Models.
  4. Find the model to be updated and click the small camera icon at the bottom of the model card.
  5. Click Select Image and then select a saved image.
  6. Click Upload.

  • No labels