Objeto Device

Describe el objeto JSON de un Device.

Un Device en Netux | Cloud puede almacenar una o más Variables. Los Devices pueden tener una ubicación exacta y un tipo predefinido.

PropiedadTipoDescripción
idStringId de Device
labelStringLabel de Device
nameStringName de Device
createdAtStringDate cuando Device fue creado
descriptionStringDescripción de Device
isActiveBooleanVerdadero si Device está activo
lastActivityNumberDate de última actividad de Device
organizationOrganization ModelOrganization a la que el Device pertenece
locationObjectUbicación GPS como fue establecida en Device properties. Este es un campo read-only (solo lectura); para establecer una ubicación, envía el objeto _location_fixed en el parámetro de cuerpo properties.
tagsString ArrayTags de Device
urlStringURL de Device
variablesStringURL de Variables de Device
variablesCountIntegerNúmero de Variables en el Device
propertiesObjectPropiedades del dispositivo, incluyendo soporte para:
- _color: Color del dispositivo en formato hexadecimal #rrggbb.
- _iconEtiqueta Font Awesome v6.1.1 del icono del dispositivo.

Device

{
    "properties": {
        "_color": "#EA6F4C",
        "_icon": "cloud-sun",
        "_location_fixed": {
            "lat": 6.2486,
            "lng": 75.5742
           }
    },
    "createdAt": "2019-11-25T19:35:08.975270Z",
    "description": "some description",
    "id": "6e309da44fc8455a9cceb5aa",
    "isActive": true,
    "label": "first-device",
    "lastActivity": null,
    "name": "First Device",
    "organization": {
        "id": "af92e4c82bf1d39cc21882f5b",
        "label": "my-first-customer",
        "name": "My First Customer",
        "url": "http://api.netux.com/api/v2.0/organizations/af92e4c82bf1d39cc21882f5b"
    },
    "tags": ["first"],
    "url": "http://api.netux.com/api/v2.0/devices/6e309da44fc8455a9cceb5aa",
    "variables": "http://api.netux.com/api/v2.0/devices/6e309da44fc8455a9cceb5aa/variables",
    "variablesNumber": 1
}

Objeto Properties

El objeto key properties describe lo siguiente sobre un Device:

  • Color.
  • Icono.
  • Configuración para de estos tipos de propiedades : Boolean, Date, List, Number, Text.
  • Values de las propiedades.
  • Device type (sólo lectura).
  • Modo de localización y sus respectivos derivados.
PropiedadTipoDescripción
_iconStringNombre de icono Fontawesome. Este icono se pondrá al Device. Por ejemplo, "cow".
_colorStringColor del Device en formato hexadecimal. Por ejemplo, "#rrggbb"
_configObjectObjeto para configurar las propiedades de un Device. Mira los ejemplos siguientes.
_device_typeStringLabel Device Type aplicado al Device. Sólo lectura.
_location_typeStringPuede ser autospecified o manual. Leer más.

Configuración de Properties

La configuración de las propiedades de un Device se realiza a través del objeto key _config. Todas las propiedades seguirán la siguiente estructura, y luego algunas de ellas aplicarán algunas modificaciones:

{
  "<property-key>": {
    "key": "<property-key>",
    "text": "Text here", // How the property will be seen in the platform
    "type": "<type>", // Can be "boolean", "date", "list", "number" or "text"
    "value": "<default-value>",
    "description": "Description here"
  }
}

Así es como debe configurarse cada tipo de propiedad en el objeto key _config:

{
  "key": "boolean",
  "Text": "Boolean property",
  "type": "boolean",
  "value": true,
  "description": "description"
}
{
  "key": "date",
  "Text": "Date property",
  "type": "date",
  "value": null,
  "description": "description"
}
{
  "key": "list",
  "Text": "List property",
  "type": "list",
  "value": "",
  "options": [
    {
      "text": "Option 1",
      "value": "option-1"
    },
    {
      "text": "Option 2",
      "value": "option-2"
    }
  "description": "description"
}{
  "key": "number",
  "Text": "Number property",
  "type": "number",
  "value": "10",
  "description" "description"
}
{
  "key": "number",
  "Text": "Number property",
  "type": "number",
  "value": "10",
  "description" "description"
}
{
  "key": "text",
  "Text": "Text property",
  "type": "text",
  "value": "",
  "description" "description"
}

Ejemplo de objeto Properties

{
  "properties": {
    "p1": "Test Demo",
    "p2": 10,
    "p3": "t1",
    "p4": "2021-01-21",
    "p5": true,
    "p6": "",
    "_icon": "cloud",
    "_color": "#477bbe",
    "number": "3174427149",
    "_config": {
      "p1": {
        "key": "p1",
        "text": "P1",
        "type": "text",
        "value": "",
        "description": "P1"
      },
      "p2": {
        "key": "p2",
        "text": "P2",
        "type": "number",
        "value": 10,
        "description": "P2"
      },
      "p3": {
        "key": "p3",
        "text": "P3",
        "type": "list",
        "value": "",
        "options": [
          {
            "text": "t1",
            "value": "t1"
          },
          {
            "text": "t2",
            "value": "t2"
          }
        ],
        "description": "P3"
      },
      "p4": {
        "key": "p4",
        "text": "P4",
        "type": "date",
        "value": null,
        "description": "P4"
      },
      "p5": {
        "key": "p5",
        "text": "P5",
        "type": "boolean",
        "value": true,
        "description": "P5"
      },
      "p6": {
        "key": "p6",
        "text": "P6",
        "type": "text",
        "value": "",
        "description": "P6"
      },
      "number": {
        "text": "Number",
        "type": "number"
      }
    },
    "_device_type": "demo-devices",
    "_location_type": "manual",
    "_location_fixed": {
      "lat": 6.1232,
      "lng": -75.34
    },
    "_location_variable": "demo"
  }
}