Messages.h File Reference

List of Pixel messages and their respective classes. More...

#include <cstdint>
#include "PixelTypes.h"

Include dependency graph for Messages.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	Systemic::Pixels::Messages::PixelMessage
struct	Systemic::Pixels::Messages::IAmADie
	Message send by a Pixel after receiving a "WhoAmI" message. More...
struct	Systemic::Pixels::Messages::RollState
	Message send by a Pixel to notify of its rolling state. More...
struct	Systemic::Pixels::Messages::Blink
	Message send to a Pixel to have it blink its LEDs. More...
struct	Systemic::Pixels::Messages::BatteryLevel
	Message send by a Pixel to notify of its battery level and state. More...
struct	Systemic::Pixels::Messages::RequestRssi
	Message send to a Pixel to configure RSSI reporting. More...
struct	Systemic::Pixels::Messages::Rssi
	Message send by a Pixel to notify of its measured RSSI. More...

Namespaces
namespace	Systemic::Pixels
	A collection of C++ classes and types to scan for and connect to Pixels dice.

Enumerations
enum class	Systemic::Pixels::Messages::MessageType : uint8_t {   None = 0 , WhoAreYou , IAmADie , RollState ,   Telemetry , BulkSetup , BulkSetupAck , BulkData ,   BulkDataAck , TransferAnimSet , TransferAnimSetAck , TransferAnimSetFinished ,   TransferSettings , TransferSettingsAck , TransferSettingsFinished , TransferTestAnimSet ,   TransferTestAnimSetAck , TransferTestAnimSetFinished , DebugLog , PlayAnim ,   PlayAnimEvent , StopAnim , RemoteAction , RequestRollState ,   RequestAnimSet , RequestSettings , RequestTelemetry , ProgramDefaultAnimSet ,   ProgramDefaultAnimSetFinished , Blink , BlinkAck , RequestDefaultAnimSetColor ,   DefaultAnimSetColor , RequestBatteryLevel , BatteryLevel , RequestRssi ,   Rssi , Calibrate , CalibrateFace , NotifyUser ,   NotifyUserAck , TestHardware , TestLedLoopback , LedLoopback ,   SetTopLevelState , ProgramDefaultParameters , ProgramDefaultParametersFinished , SetDesignAndColor ,   SetDesignAndColorAck , SetCurrentBehavior , SetCurrentBehaviorAck , SetName ,   SetNameAck , Sleep , ExitValidation , TransferInstantAnimSet ,   TransferInstantAnimSetAck , TransferInstantAnimSetFinished , PlayInstantAnim , StopAllAnims ,   RequestTemperature , Temperature , EnableCharging , DisableCharging ,   Discharge , BlinkId , BlinkIdAck }
	Lists all the Pixel dice message types. The value is used for the first byte of data in a Pixel message to identify it's type. These message identifiers have to match up with the ones on the firmware.
enum class	Systemic::Pixels::Messages::TelemetryRequestMode : uint8_t { Off , Once , Automatic }
	Available modes for telemetry requests. More...

Functions
const char *	Systemic::Pixels::Messages::getMessageName (MessageType type)
	Returns the name of a Pixel message. More...

Detailed Description

List of Pixel messages and their respective classes.

Enumeration Type Documentation

TelemetryRequestMode

enum class Systemic::Pixels::Messages::TelemetryRequestMode : uint8_t

strong

Available modes for telemetry requests.

Enumerator
Off	Request Pixel to stop automatically sending telemetry updates.
Once	Request Pixel to immediately send a single telemetry update.
Automatic	Request Pixel to automatically send telemetry updates.

Function Documentation

getMessageName()

const char * Systemic::Pixels::Messages::getMessageName

(

MessageType

type

)

Returns the name of a Pixel message.

Parameters

type	The message type to get the name for.

Returns

The name of the message represented by given message type.