Endpunkt-Sammlung

Das Endpunkt-Sammlungsobjekt repräsentiert eine Sammlung von Endpunkten, die in einem Gerät enthalten sind. Typischerweise wird auf die Liste der Endpunkte über die Eigenschaft endpoints des device-Objekts zugegriffen.

Eigenschaften

count (integer) Die Eigenschaft count gibt die Anzahl der in der Sammlung enthaltenen Endpunkte an.

Beispiele

Dieses Beispiel zeigt die Anzahl der Endpunkte eines Geräts in der Log-Konsole.

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

Methoden

byAddress(address) Die Methode byAddress() ermöglicht das Auffinden eines Endpunkts innerhalb der Sammlung durch Angabe seiner Adresse.

Parameter

• address (string): this parameter indicates the address of the endpoint being searched. The search is case insensitive.

Ergebnis

Wenn die Methode einen Endpunkt mit der angegebenen Adresse findet, wird ein endpoint-Objekt zurückgegeben, das diesen Endpunkt repräsentiert. Wenn kein Endpunkt mit der angegebenen Adresse gefunden werden kann, wird der Wert null zurückgegeben.

Beispiel 1

Dieses Beispiel zeigt die Beschreibung des Endpunkts mit der Adresse "1" in einem Gerät in der Log-Konsole.

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

byIndex(index) Die Methode byIndex() ermöglicht das Auffinden eines Endpunkts innerhalb der Sammlung durch Angabe seiner Position in der Sammlung.

Parameter

• index (integer): this parameter indicates the position of the endpoint within the collection. The first endpoint in the collection has index 0 (zero).

Ergebnis

Wenn die Methode einen Endpunkt mit dem angegebenen Index findet, wird ein endpoint-Objekt zurückgegeben, das diesen Endpunkt repräsentiert. Wenn kein Endpunkt mit dem angegebenen Index gefunden werden kann, wird der Wert null zurückgegeben.

Beispiel 1

Dieses Beispiel zeigt die Beschreibung des vierten Endpunkts eines Geräts in der Log-Konsole.

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

byType(type [, subType]) Die Methode byType() ermöglicht das Auffinden des ersten Endpunkts eines bestimmten Typs (und optional eines Subtyps) innerhalb der Sammlung.

Parameter

• type (integer): this parameter indicates the endpoint type being searched. The possible values for the type parameter can be found in the explanation of the endpointType-Eigenschaft des endpoint-Objekts.
• subType (optional, integer): if this parameter is included, the method will search for the first endpoint that is of the type specified in the type parameter, and that is also of the subtype specified in the subType parameter. The possible values for the subType parameter can be found in the explanation of the endpointSubType property of the endpoint-Objekts.

Ergebnis

Wenn die Methode einen Endpunkt mit dem angegebenen Typ und Subtyp findet, wird ein endpoint-Objekt zurückgegeben, das diesen Endpunkt repräsentiert. Wenn kein Endpunkt mit dem angegebenen Typ und Subtyp gefunden werden kann, wird der Wert null zurückgegeben.

Beispiel 1

Dieses Beispiel zeigt die Beschreibung des ersten Temperatursensors, der in einem Gerät enthalten ist, in der Log-Konsole.

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

Beispiel 2

Dieses Beispiel zeigt die Beschreibung des ersten CO2-Konzentrationssensors, der in einem Gerät enthalten ist, in der Log-Konsole.

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

allByType(type [, subType]) Die Methode AllByType() funktioniert ähnlich wie die Methode byType(), gibt jedoch ein Array mit allen Endpunkten zurück, die den angegebenen Kriterien entsprechen.

Parameter

• type (integer): this parameter indicates the endpoint type being searched. The possible values for the type parameter can be found in the explanation of the endpointType-Eigenschaft des endpoint-Objekts.
• subType (optional, integer): if this parameter is included, the method will search only for endpoints that are of the type specified in the type parameter, and that are also of the subtype specified in the subType parameter. The possible values for the subType parameter can be found in the explanation of the endpointSubType property of the endpoint-Objekts.

Ergebnis

Die Methode gibt ein Array mit allen Endpunkten zurück, die den angegebenen Kriterien entsprechen. Wenn kein Endpunkt gefunden wird, gibt die Methode ein leeres Array zurück.

Beispiel 1

Dieses Beispiel zeigt die Beschreibungen aller Temperatursensoren, die in einem Gerät enthalten sind, in der Log-Konsole.

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

byTag(tag) Die Methode byTag() ermöglicht das Auffinden des ersten Endpunkts, der das angegebene Tag innerhalb der Sammlung enthält.

Parameter

• tag (string): this parameter indicates the tag being searched. The search is case insensitive.

Ergebnis

Wenn die Methode einen Endpunkt mit dem angegebenen Tag findet, wird ein endpoint-Objekt zurückgegeben, das diesen Endpunkt repräsentiert. Wenn kein Endpunkt mit dem angegebenen Tag gefunden werden kann, wird der Wert null zurückgegeben.

Beispiel 1

Dieses Beispiel zeigt die Beschreibung des ersten Endpunkts mit dem Tag "SomeTag".

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

allByTag(tag) Die Methode AllByTag() funktioniert ähnlich wie die Methode byTag(), gibt jedoch ein Array mit allen Endpunkten zurück, die den angegebenen Kriterien entsprechen.

Parameter

• tag (string): this parameter indicates the tag being searched. The search is case insensitive.

Ergebnis

Die Methode gibt ein Array mit allen Endpunkten zurück, die den angegebenen Kriterien entsprechen. Wenn kein Endpunkt gefunden wird, gibt die Methode ein leeres Array zurück.

Beispiel 1

Dieses Beispiel zeigt die Beschreibungen aller Endpunkte, die das Tag "SomeTag" enthalten.

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

toArray() Die Methode toArray() ermöglicht die Konvertierung der Endpunkt-Sammlung in ein Array, das alle Endpunkte der Sammlung enthält.

Beispiel 1

Dieses Beispiel zeigt die Beschreibung aller Endpunkte eines Geräts in der Log-Konsole.

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