OcaBitstringSensor¶
A online version of the AES70 specification of this class can be found at http://docs.deuso.de.
The class is a subclass of OcaBasicSensor()
.
This class defines the properties
Name |
JavaScript Type |
AES70 Type |
---|---|---|
BitString |
boolean[] |
OcaBitstring |
Furthermore, it inherits the properties ClassID, ClassVersion, ObjectNumber, Lockable, Role, Enabled, Ports, Label, Owner, Latency, ReadingState and BitString.
-
class
OcaBitstringSensor
(objectNumber, device)¶ Bit string sensor.
-
OcaBitstringSensor.
OnBitStringChanged
¶ type: PropertyEvent.<Array.<boolean>>
This event is emitted when the property BitString changes in the remote object. The property
BitString
is described in the AES70 standard as follows. The bitstring.
-
OcaBitstringSensor.
GetBit
(bitNr)¶ Gets the value of the given bit. Return status indicates success or failure of the retrieval.
- Arguments
bitNr (number) –
- Returns
Promise.<number> – A promise which resolves to a single value of type
number
.
-
OcaBitstringSensor.
GetBitString
()¶ Gets the entire bitstring. Return status indicates success or failure of the retrieval.
- Returns
Promise.<Array.<boolean>> – A promise which resolves to a single value of type
boolean[]
.
-
OcaBitstringSensor.
GetNrBits
()¶ Gets the number of bits of the bitmask data. Returned status indicates success or failure of the retrieval.
- Returns
Promise.<number> – A promise which resolves to a single value of type
number
.
-