Endpoint collection

El objeto endpoint collection representa una colección de endpoints contenidos en un dispositivo. Usualmente se accede a la lista de endpoints a través de la propiedad endpoints del objeto device.

Propiedades

### count (integer) La propiedad count indica la cantidad de endpoints incluidos en la colección.

Ejemplos

Este ejemplo muestra la cantidad de endpoints de un dispositivo en la consola de log.

env.log('Endpoint count: ', myDevice.endpoints.count);

Métodos

### byAddress(address) El método byAddress() permite encontrar un endpoint dentro de la colección, indicando su dirección.

Parámetros

• address (string): este parámetro indica la dirección del endpoint buscado. La búsqueda es de tipo case insensitive, es decir que no distingue entre mayúsculas y minúsculas.

Resultado

Si el método encuentra un endpoint con la dirección indicada, se devolverá un objeto de tipo endpoint, que representa ese endpoint. Si no es posible encontrar ningún endpoint con la dirección indicada, se devolverá el valor null.

Ejemplo 1

Este ejemplo muestra la descripción del endpoint con dirección “1” en un dispositivo, utilizando la consola de log.

env.log(myDevice.endpoints.byAddress("1").description);

### byIndex(index) El método byIndex() permite encontrar un endpoint dentro de la colección, indicando su posición en la colección.

Parámetros

• index (integer): este parámetro indica la posición del endpoint dentro de la colección. El primer endpoint de la colección tiene el índice 0 (cero).

Resultado

Si el método encuentra un endpoint con el índice dado, se devolverá un objeto de tipo endpoint, que representa ese endpoint. Si no es posible encontrar ningún endpoint con la dirección indicada, se devolverá el valor null.

Ejemplo 1

Este ejemplo muestra la descripción del cuarto endpoint de un dispositivo, utilizando la consola de log.

env.log(myDevice.endpoints.byIndex(3).description);

### byType(type [, subType]) El método byType() permite encontrar el primer endpoint de un tipo dado (y opcionalmente de un subtipo), dentro de la colección.

Parámetros

• type (integer): este parámetro indica el tipo de endpoint que se busca. Los valores posibles para el parámetro type pueden verse en la explicación de la propiedad endpointType del objeto endpoint.
• subType (opcional, integer): en caso de incluir este parámetro, el método buscará el primer endpoint que sea del tipo especificado en el parámetro type, y que además sea del subtipo indicado en el parámetro subType. Los valores posibles para el parámetro subType pueden verse en la explicación de la propiedad endpointSubType del objeto endpoint.

Resultado

Si el método encuentra un endpoint con el tipo y subtipo indicados, se devolverá un objeto de tipo endpoint, que representa ese endpoint. Si no es posible encontrar ningún endpoint con el tipo y subtipo dados, se devolverá el valor null.

Ejemplo 1

Este ejemplo muestra la descripción del primer sensor de temperatura contenido en un dispositivo, utilizando la consola de log.

env.log(myDevice.endpoints.byType(endpointType.temperatureSensor).description);

Ejemplo 2

Este ejemplo muestra la descripción del primer sensor de concentración de CO₂ contenido en un dispositivo, utilizando la consola de log.

env.log
(
  myDevice.endpoints.byType
  (
      endpointType.ppmConcentrationSensor,
      ppmConcentrationSensorSubType.carbonDioxide
  )
  .description
);

### allByType(type [, subType]) El método AllByType() funciona similar al método byType(), pero permite obtener un array con todos los endpoints que cumplan el criterio indicado.

Parámetros

• type (integer): este parámetro indica el tipo de endpoint que se busca. Los valores posibles para el parámetro type pueden verse en la explicación de la propiedad endpointType del objeto endpoint.
• subType (opcional, integer): en caso de incluir este parámetro, el método buscará sólo endpoints que sean del tipo especificado en el parámetro type, y que además sean del subtipo indicado en el parámetro subType. Los valores posibles para el parámetro subType pueden verse en la explicación de la propiedad endpointSubType del objeto endpoint.

Resultado

El método devuelve un array con todos los endpoints que cumplan el criterio indicado. Si no se encuentra ningún endpoint, el método devolverá un array vacío.

Ejemplo 1

Este ejemplo muestra las descripciones de todos los sensor de temperatura contenidos en un dispositivo, utilizando la consola de log.

myDevice.endpoints.allByType(endpointType.temperatureSensor).forEach((item) => env.log(item.description));

### byTag(tag) El método byTag() permite encontrar el primer endpoint que contenga el tag indicado, dentro de la colección.

Parámetros

• tag (string): este parámetro indica el tag que se está buscando. La búsqueda no distingue entre mayúsculas y minúsculas.

Resultado

Si el método encuentra un endpoint con el tag indicado, se devolverá un objeto de tipo endpoint, que representa ese endpoint. Si no es posible encontrar ningún endpoint con el tag indicado, se devolverá el valor null.

Ejemplo 1

Este ejemplo muestra la descripción del primer endpoint con el tag “SomeTag”.

env.log(myDevice.endpoints.byTag("SomeTag").description);

### allByTag(tag) El método AllByTag() funciona similar al método byTag(), pero permite obtener un array con todos los endpoints que cumplan el criterio indicado.

Parámetros

• tag (string): este parámetro indica el tag que se está buscando. La búsqueda no distingue entre mayúsculas y minúsculas.

Resultado

El método devuelve un array con todos los endpoints que cumplan el criterio indicado. Si no se encuentra ningún endpoint, el método devolverá un array vacío.

Ejemplo 1

Este ejemplo muestra las descripciones de todos los endpoints que contengan el tag “SomeTag”.

myDevice.endpoints.allByTag("SomeTag").forEach((item) => env.log(item.description));

### toArray() El método toArray() permite convertir la colección de endpoints a un array conteniendo todos los endpoints en la colección.

Ejemplo 1

Este ejemplo muestra la descripción de todos los endpoints de un dispositivo, utilizando la consola de log.

myDevice.endpoints.toArray().forEach(element => env.log(element.description));