IoT Platform:Agregar una función TSL

Requisitos previos

Se ha creado un producto. Para obtener más información, consulte Create a product.

Notas de uso

• Debe configurar las funciones TSL en módulos. La suma de los módulos predeterminados y los módulos personalizados en cada producto no puede exceder 20.

• Si un producto está publicado, no puede modificar el modelo TSL del producto. Para modificar un modelo TSL, debe cancelar la publicación del producto para el cual se definió el modelo TSL.

• Puede modificar una versión histórica de un modelo TSL para generar una nueva versión.

• IoT Platform guarda las 10 versiones más recientes de un modelo TSL. Las versiones anteriores se sobrescriben.

• Después de modificar un modelo TSL, debe publicar la versión del modelo TSL para que la actualización surta efecto.

Para obtener más información, consulte Limits.

Procedimiento

1. Inicie sesión en la consola de IoT Platform.

2. En la esquina superior izquierda de la consola de IoT Platform, seleccione la región donde está activado IoT Platform.

3. En la pestaña All environment de la página Overview, busque la instancia que desea gestionar y haga clic en el ID de la instancia o en su nombre.

4. En el panel de navegación izquierdo, elija Devices > Products. En la lista de productos, busque el producto que desea gestionar y haga clic en View en la columna Actions.

5. En la página de detalles del producto, haga clic en la pestaña Define Feature, luego en Edit Draft y, a continuación, en Default Module o Add Module.

6. Opcional. Si desea agregar un módulo, configure los parámetros obligatorios y haga clic en OK. Luego, haga clic en el nombre del módulo agregado. La siguiente tabla describe los parámetros.

   Parámetro	Descripción
   Module Name	El nombre debe tener entre 4 y 30 caracteres, y puede contener letras, dígitos y guiones bajos (_).
   Module Identifier	El identificador del módulo. Debe ser único dentro de un producto. Debe tener entre 1 y 30 caracteres, y puede contener letras, dígitos y guiones bajos (_).
   Module Description	La descripción del módulo. Debe tener entre 1 y 4096 caracteres.

7. Opcional. Seleccione una versión en la lista desplegable Version History y haga clic en Roll Back. A continuación, podrá modificar el modelo TSL basándose en la versión histórica.

8. Agregar una función personalizada.

   Haga clic en Add Self-defined Feature. A continuación, puede agregar una propiedad, un servicio o un evento al producto.

   • Agregar una propiedad: En el cuadro de diálogo Add Self-defined Feature, seleccione Properties en el campo Feature Type. Configure los parámetros y haga clic en OK.

     La siguiente tabla describe los parámetros.

     Parámetro	Descripción
     Feature Name	El nombre de la propiedad. Ejemplo: consumo de energía. El nombre debe ser único dentro de un producto. El nombre debe tener entre 1 y 30 caracteres, y puede contener letras, dígitos, guiones (-), guiones bajos (_), barras diagonales (/) y puntos (.). Debe comenzar con una letra o un dígito.
     Identifier	El identificador de la propiedad. Debe ser único dentro de un producto. Este identificador corresponde al valor del parámetro identifier en el formato JSON de Alink. Un dispositivo utiliza este identificador como clave para reportar datos de propiedades. IoT Platform verifica el identificador para determinar si recibe los datos. Debe tener entre 1 y 50 caracteres, y puede contener letras, dígitos y guiones bajos (_). Ejemplo: PowerConsumption. Nota No puede establecer este parámetro con ninguna de las siguientes palabras reservadas: set, get, post, property, event, time y value.
     Data type	int32: entero de 32 bits. Debe especificar un rango de valores, un tamaño de paso y una unidad. float: número de punto flotante de precisión simple. Debe especificar un rango de valores, un tamaño de paso y una unidad. double: número de punto flotante de precisión doble. Debe especificar un rango de valores, un tamaño de paso y una unidad. enum: enumeración. Debe especificar un valor y una descripción para cada elemento de la enumeración. Ejemplos: 1-modo calefacción y 2-modo refrigeración. bool: booleano. Debe usar 0 o 1 para definir un valor booleano. Ejemplos: 0 indica apagado y 1 indica encendido. text: cadena. Debe especificar la longitud de la cadena. La cadena debe tener entre 1 y 10,240 bytes. date: marca de tiempo. Una marca de tiempo UTC en formato de cadena. Unidad: milisegundos. struct: objeto JSON. Debe definir una estructura JSON y agregar parámetros JSON a dicha estructura. Por ejemplo, puede definir el color de una lámpara como una estructura que consta de los siguientes parámetros: Red, Green y Blue. No se admiten estructuras anidadas. array: arreglo. Debe especificar el tipo de datos y el número de elementos en un arreglo. Valores válidos para el tipo de elemento: int32, float, double, text y struct. Los elementos de un arreglo deben ser del mismo tipo. Valores válidos para el número de elementos: de 1 a 512. Nota Este parámetro no es obligatorio si el parámetro Gateway Connection Protocol de un producto está establecido en Modbus.
     Value range	Si el parámetro Data Type está establecido en int32, float o double, especifique un rango de valores para la propiedad.
     Step	El tamaño mínimo de incremento con el que pueden cambiar los valores de la propiedad. Si el parámetro Data Type está establecido en int32, float o double, puede especificar un tamaño de paso según sus necesidades comerciales. Por ejemplo, desea agregar la propiedad de temperatura a un producto de termómetro. Puede establecer el parámetro Data Type en int32, el parámetro Step en 2, el parámetro Unit en °C y el parámetro Value Range en 0 a 100. En este caso, cada vez que la temperatura cambie 2 °C, el dispositivo del producto de termómetro reportará un valor de temperatura, como 0 °C, 2 °C, 4 °C, 6 °C u 8 °C.
     Unidad del precio de la instancia.	Puede seleccionar Ninguna u otros valores según su escenario comercial.
     Read/Write Type	Read/Write: Se admiten solicitudes GET y SET. Read-only: Solo se admiten solicitudes GET. Nota Este parámetro no es obligatorio si el parámetro Gateway Connection Protocol de un producto está establecido en Modbus.
     Description	La descripción de la función. La descripción no puede exceder los 100 caracteres.
     Extended Information	La información extendida especifica la asignación entre el protocolo de conexión y el modelo TSL estándar del dispositivo. Después de configurar los ajustes extendidos en un modelo TSL, puede verlos en la pestaña TSL Extension Information del modelo TSL en la consola de IoT Platform. Si el parámetro Gateway Connection Protocol de un gateway sub-device está establecido en Custom, OPC UA o Modbus, debe especificar la información extendida. Si el parámetro Gateway Connection Protocol está establecido en Custom, especifique una descripción en formato JSON para las configuraciones personalizadas. La descripción debe tener entre 1 y 1,024 caracteres. Si el parámetro Gateway Connection Protocol está establecido en OPC UA, introduzca un nombre de nodo. Cada nombre de nodo que especifique para una propiedad debe ser único. Si el parámetro Gateway Connection Protocol está establecido en Modbus, configure los siguientes parámetros: Operation Type: Puede establecer este parámetro en uno de los siguientes valores. Discrete Input (solo lectura, 0x02) Coil Status (solo lectura, 0x01) Coil Status (lectura y escritura, 0x01-lectura, 0x05-escritura) Coil Status (lectura y escritura, 0x01-lectura, 0x0F-escritura) Coil Status (solo escritura, 0x05) Coil Status (solo escritura, 0x0F) Holding Registers (solo lectura, 0x03) Holding Registers (lectura y escritura, 0x03-lectura, 0x06-escritura) Holding Registers (lectura y escritura, 0x03-lectura, 0x10-escritura) Holding Registers (solo escritura, 0x06) Holding Registers (solo lectura, 0x10) Input Registers (solo lectura, 0x04) Register Address: Debe especificar un valor hexadecimal que comience con 0x. Valores válidos: 0x0 to 0xFFFF. Ejemplo: 0xFE. Original Data Type: Se admiten varios tipos de datos. Valores válidos: int16, uint16, int32, uint32, int64, uint64, float, double, string, bool y bits. Bit Position: Debe configurar este parámetro si el parámetro Original Data Type está establecido en bits. Seleccione la posición del bit donde se almacenan los datos. Value Range: El rango de valores se obtiene después de procesar los datos originales mediante un factor de escala especificado. Los datos que excedan el rango de valores se descartan. IoT Platform define los rangos de valores predeterminados para los siguientes tipos de operaciones: Coil Status: 0 a 1 Discrete Input: 0 a 1 Holding Registers: -2147483648 a 2147483647 Input Registers: -2147483648 a 2147483647 Switch High Byte and Low Byte in Register: Especifica si se intercambian los primeros 8 bits y los últimos 8 bits del entero de 16 bits en el registro. Valores válidos: true: El sistema intercambia los primeros 8 bits y los últimos 8 bits. false: El sistema no intercambia los primeros 8 bits y los últimos 8 bits. Switch Register Bits Sequence: Especifica si se intercambian los primeros 16 bits y los últimos 16 bits del entero original de 32 bits. Valores válidos: true: El sistema intercambia los primeros 16 bits y los últimos 16 bits. false: El sistema no intercambia los primeros 16 bits y los últimos 16 bits. Scale Factor: Especifica un número entero o de punto flotante. Valor predeterminado: 1. El valor no puede ser 0 ni negativo. Data Report: Puede seleccionar At Specific Time o Report Changes.

   • Agregar un servicio: En el cuadro de diálogo Add Self-defined Feature, seleccione Services en el campo Feature Type. Configure los parámetros y haga clic en OK.

     Nota

     Si el parámetro Gateway Connection Protocol está establecido en Modbus, no puede agregar servicios.

     La siguiente tabla describe los parámetros.

     Parámetro	Descripción
     Feature Name	El nombre del servicio. El nombre debe tener entre 1 y 30 caracteres, y puede contener letras, dígitos, guiones (-), guiones bajos (_), barras diagonales (/) y puntos (.). Debe comenzar con una letra o un dígito.
     Identifier	El identificador del servicio. Debe ser único dentro de un producto. Este identificador corresponde al valor del parámetro identifier especificado para el servicio en el formato JSON de Alink. Debe tener entre 1 y 50 caracteres, y puede contener letras, dígitos y guiones bajos (_). Nota No puede establecer este parámetro con ninguna de las siguientes palabras reservadas: set, get, post, property, event, time y value.
     Invocation method	Asynchronous: IoT Platform devuelve el resultado después de invocar el servicio. IoT Platform no espera una respuesta del dispositivo. Synchronous: IoT Platform espera una respuesta del dispositivo. Si no se devuelve ninguna respuesta, la invocación del servicio agota el tiempo de espera.
     Input Parameters	Opcional. Los parámetros de entrada del servicio. En el cuadro de diálogo que aparece, haga clic en + Add Parameter para agregar un parámetro de entrada. Si el parámetro Gateway Connection Protocol está establecido en OPC UA, debe configurar un índice de parámetro para especificar el orden de los parámetros. Nota No puede establecer este parámetro con ninguna de las siguientes palabras reservadas: set, get, post, property, event, time y value. Puede usar una propiedad como parámetro de entrada o configurar un parámetro de entrada personalizado. Por ejemplo, al definir el servicio Automatic Sprinkling, puede usar las propiedades predefinidas Sprinkling Interval y Sprinkling Amount como parámetros de entrada. Cuando IoT Platform invoca el servicio Automatic Sprinkling, el dispositivo de riego comienza a regar según el intervalo y la cantidad de riego especificados. Puede agregar hasta 20 parámetros de entrada para cada servicio.
     Output Parameters	Opcional. Los parámetros de salida del servicio. En el cuadro de diálogo que aparece, haga clic en + Add Parameter para agregar un parámetro de salida. Si el parámetro Gateway Connection Protocol está establecido en OPC UA, debe configurar un índice de parámetro para especificar el orden de los parámetros. Nota No puede establecer este parámetro con ninguna de las siguientes palabras reservadas: set, get, post, property, event, time y value. Puede usar una propiedad como parámetro de salida o configurar un parámetro de salida personalizado. Por ejemplo, al definir el servicio Automatic Sprinkling, puede usar la propiedad predefinida Soil Humidity como parámetro de salida. Cuando IoT Platform invoca el servicio Automatic Sprinkling, se devuelven datos relacionados con la humedad del suelo. Puede agregar hasta 20 parámetros de salida para cada servicio.
     Extended Information	La información extendida especifica la asignación entre el protocolo de conexión y el modelo TSL estándar del dispositivo. Después de configurar los ajustes extendidos en un modelo TSL, puede ver estos ajustes en la pestaña TSL Extension Information del modelo TSL en la consola de IoT Platform. Si el parámetro Gateway Connection Protocol de un gateway sub-device está establecido en Custom o OPC UA, debe especificar la información extendida. Si el parámetro Gateway Connection Protocol está establecido en Custom, especifique una descripción en formato JSON para las configuraciones personalizadas. La descripción debe tener entre 1 y 1,024 caracteres. Si el parámetro Gateway Connection Protocol está establecido en OPC UA, introduzca un nombre de nodo. Cada nombre de nodo que especifique para un servicio debe ser único.
     Description	La descripción del servicio. La descripción debe tener entre 1 y 100 caracteres.

   • Agregar un evento: En el cuadro de diálogo Add Self-defined Feature, seleccione Events en el campo Feature Type. Configure los parámetros y haga clic en OK.

     Nota

     Si el parámetro Gateway Connection Protocol está establecido en Modbus, no puede agregar eventos.

     La siguiente tabla describe los parámetros.

     Parámetro	Descripción
     Feature Name	El nombre del evento. El nombre debe tener entre 1 y 30 caracteres, y puede contener letras, dígitos, guiones (-), guiones bajos (_), barras diagonales (/) y puntos (.). Debe comenzar con una letra o un dígito.
     Identifier	El identificador del evento. Debe ser único dentro de un producto. Este identificador corresponde al valor del parámetro identifier en el formato JSON de Alink. Un dispositivo utiliza este identificador como clave para reportar datos de eventos. Ejemplo: ErrorCode. Debe tener entre 1 y 50 caracteres, y puede contener letras, dígitos y guiones bajos (_). Nota No puede establecer este parámetro con ninguna de las siguientes palabras reservadas: set, get, post, property, event, time y value.
     Tipo de evento.	Puede realizar procesamiento lógico o análisis para eventos de diferentes tipos. Info: Los dispositivos reportan notificaciones comunes, como una notificación de finalización de tarea. Alert: Los dispositivos reportan emergencias o excepciones que ocurren durante la ejecución del dispositivo. Los eventos de este tipo tienen una prioridad alta. Error: Los dispositivos reportan emergencias o excepciones que ocurren durante la ejecución del dispositivo. Los eventos de este tipo tienen una prioridad alta.
     Output Parameters	Los parámetros de salida de un evento. En el cuadro de diálogo que aparece, haga clic en + Add Parameter para agregar un parámetro de salida. Puede usar una propiedad como parámetro de salida o configurar un parámetro de salida personalizado. Por ejemplo, puede usar la propiedad predefinida Voltage como parámetro de salida. Si un dispositivo reporta un error relacionado con el voltaje, también se reporta el voltaje del dispositivo para facilitar la solución de problemas. Si el parámetro Gateway Connection Protocol está establecido en OPC UA, debe configurar un índice de parámetro para especificar el orden de los parámetros. Nota No puede establecer este parámetro con ninguna de las siguientes palabras reservadas: set, get, post, property, event, time y value. Puede definir hasta 50 parámetros de salida para un evento.
     Extended Information	La información extendida especifica la asignación entre el protocolo de conexión y el modelo TSL estándar del dispositivo. Después de configurar los ajustes extendidos en un modelo TSL, puede ver estos ajustes en la pestaña TSL Extension Information del modelo TSL en la consola de IoT Platform. Si el parámetro Gateway Connection Protocol de un gateway sub-device está establecido en Custom o OPC UA, debe especificar la información extendida. Si el parámetro Gateway Connection Protocol está establecido en Custom, especifique una descripción en formato JSON para las configuraciones personalizadas. La descripción debe tener entre 1 y 1,024 caracteres. Si el parámetro Gateway Connection Protocol está establecido en OPC UA, introduzca un nombre de nodo. Cada nombre de nodo que especifique para un evento debe ser único.
     Description	La descripción del evento. La descripción debe tener entre 1 y 100 caracteres.

Publicar un modelo TSL

1. Elija Define Feature > Edit Draft. En la esquina inferior izquierda de la página que aparece, haga clic en Release online. Aparecerá el cuadro de diálogo Release model online?.

2. Opcional. Haga clic en +Add post notes e introduzca un número de versión y una nota.

   Parámetro	Descripción
   Version Number	El número de versión del modelo TSL. Puede gestionar el modelo TSL según el número de versión. El número de versión debe tener entre 1 y 16 caracteres, y puede contener letras, dígitos y puntos (.).
   note	La descripción del modelo TSL. La descripción puede contener letras, dígitos y caracteres especiales. Debe tener entre 1 y 100 caracteres.

3. Si hay una versión en línea disponible, debe comprobar las diferencias entre la versión actual que desea publicar y la versión en línea.

   Haga clic en View Differences. En el panel View Differences, puede ver las diferencias entre las versiones. Después de confirmar los ajustes, haga clic en Confirm. En el cuadro de diálogo Release model online?, la casilla de verificación se selecciona automáticamente.

   Si no desea ver las diferencias entre las versiones, seleccione "Make sure that you have verified the differences between the current version and the online version."

4. Haga clic en OK para publicar el modelo TSL.

Resultado de la ejecución

Después de publicar un modelo TSL, puede verlo en la consola de IoT Platform. Puede realizar las siguientes operaciones en la pestaña Define Feature de la página Product Details:

• Haga clic en TSL Model para ver el modelo TSL en formato JSON.

Operaciones de API relacionadas

Qué hacer a continuación

De forma predeterminada, los datos TSL enviados por los dispositivos de un producto se escriben automáticamente en un espacio de almacenamiento de datos activos. Puede detener el servicio de almacenamiento de datos activos para algunos o todos los modelos TSL según sus necesidades comerciales.