Instantiates a Pixel.
The session used to communicate with the Pixel.
Optional
info: Partial<Pick<Readonly<{ Protected
Readonly
_msgProtected
Readonly
_serializerReadonly
isReadonly
typeDevice type is Pixels die.
Static
MutableGets the Pixel battery level (percentage).
Gets the color of the Pixel.
Gets the die face value that is currently facing up.
Gets the 0-based index of the die face that is currently facing up.
Gets the number of faces of the Pixel.
Gets the die type of the Pixel.
Gets the Pixel firmware build date.
Gets whether the Pixel battery is charging or not. Returns 'true' if fully charged but still on charger.
Whether data is being transferred from or to the die.
Gets the number of LEDs for the Pixel, may be 0 until connected to device.
Set logger to use by this instance.
Toggle logging information about each send and received message.
Toggle logging the serialized (binary) data for each send and received message.
Gets the Pixel name, may be empty until connected to device.
Gets the unique Pixel id of the device, may be 0 until connected.
Gets the on-die profile hash value. This can be used as an identifier for the current profile.
Gets the Pixel roll state.
Gets the last RSSI value notified by the Pixel.
Call () to automatically update the RSSI value.
Protected
sessionGets the Pixel last known connection status.
Gets the unique id assigned by the system to the Pixel Bluetooth peripheral.
Protected
_internalProtected
_internalProtected
_internalProtected
_internalProtected
_internalSends a message to the Pixel and wait for a specific response.
Message with the data to send or just a message type.
Expected response type.
Timeout in mill-seconds before aborting waiting for the response.
A promise resolving to the response in the form of a message type or a message object.
Protected
_internalSends a message to the Pixel and wait for a specific response which is returned casted to the expected type.
Message with the data to send or just a message type.
Expected response class type.
A promise resolving to a message object of the expected type.
Protected
_internalSends a message to the Pixel.
Message with the data to send or just a message type.
Whether to request a confirmation that the message was received.
A promise that resolves once the message has been send.
Protected
_internalProtected
_internalWaits for a message from the Pixel.
Type of the message to expect.
Timeout before aborting the wait.
A promise with the received message of the expected type.
Protected
_logProtected
_logProtected
_onProtected
_tagProtected
_warnRegisters a listener function that will be called when the specified event is raised. See PixelEventMap for the list of events and their associated data.
A case-sensitive string representing the event type to listen for.
The callback function.
Registers a listener function that will be called on receiving raw messages of a given type from the Pixel.
The type of message to watch for.
The callback function.
Adds the given listener function for the specified property.
The name of the property.
The callback function.
Requests the Pixel to blink and wait for a confirmation.
Blink color.
Optional
opt: { Optional
count?: numberNumber of blinks.
Optional
duration?: numberTotal duration of the animation in milliseconds.
Optional
faceSelect which faces to light up.
Optional
fade?: numberAmount of in and out fading, 0: sharp transition, 1: maximum fading.
Optional
loopHow many times to loop the animation.
A promise that resolves once the die has confirmed receiving the message.
Asynchronously tries to connect to the die. Throws on connection error.
Delay before giving up (may be ignored when having concurrent calls to connect()). It may take longer than the given timeout for the function to return.
A promise that resoles to this instance once the connection process has completed (whether successfully or not).
Will throw a PixelConnectError if it fails to connect in time.
Protected
emitPlays the (single) LEDs animation included in the given data set.
The data set containing just one animation to play.
A promise that resolves once the transfer has completed.
Unregisters a listener from receiving events identified by the given event name. See PixelEventMap for the list of events and their associated data.
A case-sensitive string representing the event type.
The callback function to unregister.
Unregisters a listener from receiving raw messages of a given type.
The type of message to watch for.
The callback function to unregister.
Removes the given listener function for the specified property.
The name of the property.
The callback function to unregister.
Requests the Pixel to regularly send its measured RSSI value.
Whether to turn or turn off this feature.
The minimum time interval in milliseconds between two RSSI updates.
A promise that resolves once the message has been send.
Sends a message to the Pixel and wait for a specific response.
Message with the data to send or just a message type.
Expected response type.
Timeout in mill-seconds before aborting waiting for the response.
A promise resolving to the response in the form of a message type or a message object.
Sends a message to the Pixel and wait for a specific response which is returned casted to the expected type.
Message with the data to send or just a message type.
Expected response class type.
A promise resolving to a message object of the expected type.
Sends a message to the Pixel.
Message with the data to send or just a message type.
Whether to request a confirmation that the message was received.
A promise that resolves once the message has been send.
Uploads the given data set of animations to the Pixel flash memory.
The data set to upload.
A promise that resolves once the transfer has completed.
Uploads the given data set of animations to the Pixel RAM memory. Those animations are lost when the Pixel goes to sleep, is turned off or is restarted.
The data set to upload.
A promise that resolves once the transfer has completed.
Update Pixel info from an external source such as scanning data.
The updated info.
Represents a Pixels die. Most of its methods require the instance to be connected to the Pixel device. Call the () method to initiate a connection.
Call addEventListener to get notified for rolls, connection and disconnection events and more.
Call addPropertyListener to get notified on property changes.