Description

Represents an individual BLOCKS device.

Inherits juce::ReferenceCountedObject.

Public Member Functions
	~Block () override
	Destructor. More...

bool	operator== (const Block &other) const noexcept
	Two blocks are considered equal if they have the same UID. More...

bool	operator!= (const Block &other) const noexcept
	Two blocks are considered equal if they have the same UID. More...

virtual Type	getType () const =0
	Returns the type of this device. More...

bool	isControlBlock () const
	Returns true if this a control block. More...

virtual juce::String	getDeviceDescription () const =0
	Returns a human-readable description of this device type. More...

virtual float	getBatteryLevel () const =0
	Returns the battery level in the range 0.0 to 1.0. More...

virtual bool	isBatteryCharging () const =0
	Returns true if the battery is charging. More...

virtual bool	isConnected () const =0
	Returns true if this block is connected and active. More...

virtual juce::Time	getConnectionTime () const =0
	Returns the time this block object was connected to the topology. More...

virtual bool	isConnectedViaBluetooth () const =0
	Returns true if this block or the master block this block is connected to, is connected via bluetooth. More...

virtual bool	isMasterBlock () const =0
	Returns true if this block is directly connected to the application, as opposed to only being connected to a different block via a connection port. More...

virtual UID	getConnectedMasterUID () const =0
	Returns the UID of the master block this block is connected to. More...

virtual int	getWidth () const =0
	Returns the width of the device in logical device units. More...

virtual int	getHeight () const =0
	Returns the height of the device in logical device units. More...

virtual bool	isHardwareBlock () const =0
	Returns true if the device is a physical hardware block (i.e. More...

virtual float	getMillimetersPerUnit () const =0
	Returns the length of one logical device unit as physical millimeters. More...

virtual BlockArea	getBlockAreaWithinLayout () const =0
	Returns the area that this block covers within the layout of the group as a whole. More...

virtual int	getRotation () const =0
	Returns the rotation of this block relative to the master block in 90 degree steps clockwise. More...

virtual LEDGrid *	getLEDGrid () const =0
	If this block has a grid of LEDs, this will return an object to control it. More...

virtual LEDRow *	getLEDRow ()=0
	If this block has a row of LEDs, this will return an object to control it. More...

virtual juce::Array< StatusLight * >	getStatusLights () const =0
	If this block has any status LEDs, this will return an array of objects to control them. More...

virtual TouchSurface *	getTouchSurface () const =0
	If this block has a pressure-sensitive surface, this will return an object to access its data. More...

virtual juce::Array< ControlButton * >	getButtons () const =0
	If this block has any control buttons, this will return an array of objects to control them. More...

virtual bool	supportsGraphics () const =0
	This returns true if the block supports generating graphics by drawing into a JUCE Graphics context. More...

virtual juce::Array< ConnectionPort >	getPorts () const =0
	Returns a list of the connectors that this device has. More...

virtual juce::Result	setProgram (std::unique_ptr< Program >, ProgramPersistency persistency=ProgramPersistency::setAsTemp)=0
	Sets the Program to run on this block. More...

virtual Program *	getProgram () const =0
	Returns a pointer to the currently loaded program. More...

void	addProgramLoadedListener (ProgramLoadedListener *)
	Adds a new listener for program load completions. More...

void	removeProgramLoadedListener (ProgramLoadedListener *)
	Removes a listener for program load completions. More...

virtual void	sendProgramEvent (const ProgramEventMessage &)=0
	Sends a message to the currently loaded program. More...

void	addProgramEventListener (ProgramEventListener *)
	Adds a new listener for custom program events from the block. More...

void	removeProgramEventListener (ProgramEventListener *)
	Removes a listener for custom program events from the block. More...

virtual juce::uint32	getMemorySize ()=0
	Returns the overall memory of the block. More...

virtual juce::uint32	getHeapMemorySize ()=0
	Returns the size of the data block that setDataByte and other functions can write to. More...

virtual void	setDataByte (size_t offset, juce::uint8 value)=0
	Sets a single byte on the littlefoot heap. More...

virtual void	setDataBytes (size_t offset, const void *data, size_t num)=0
	Sets multiple bytes on the littlefoot heap. More...

virtual void	setDataBits (juce::uint32 startBit, juce::uint32 numBits, juce::uint32 value)=0
	Sets multiple bits on the littlefoot heap. More...

template<typename Type >
void	setData (juce::uint32 offset, Type value)
	Sets a single, 32 bit or less, value on the littlefoot heap. More...

virtual juce::uint8	getDataByte (size_t offset)=0
	Gets a byte from the littlefoot heap. More...

virtual void	saveProgramAsDefault ()=0
	Sets the current program as the block's default state. More...

virtual void	resetProgramToDefault ()=0
	Resets the loaded program to the block's default state. More...

void	addConfigItemListener (ConfigItemListener *)
	Adds a new listener for config item changes. More...

void	removeConfigItemListener (ConfigItemListener *)
	Removes a listener for config item changes. More...

virtual juce::uint32	getMaxConfigIndex ()=0
	Returns the maximum number of config items available. More...

virtual bool	isValidUserConfigIndex (juce::uint32 item)=0
	Determine if this is a valid config item index. More...

virtual juce::int32	getLocalConfigValue (juce::uint32 item)=0
	Get local config item value. More...

virtual void	setLocalConfigValue (juce::uint32 item, juce::int32 value)=0
	Set local config item value. More...

virtual void	setLocalConfigRange (juce::uint32 item, juce::int32 min, juce::int32 max)=0
	Set local config item range. More...

virtual void	setLocalConfigItemActive (juce::uint32 item, bool isActive)=0
	Set if config item is active or not. More...

virtual bool	isLocalConfigItemActive (juce::uint32 item)=0
	Determine if config item is active or not. More...

virtual ConfigMetaData	getLocalConfigMetaData (juce::uint32 item)=0
	Get config item metadata. More...

virtual void	requestFactoryConfigSync ()=0
	Request sync of factory config with block. More...

virtual void	resetConfigListActiveStatus ()=0
	Reset all items active status. More...

virtual void	factoryReset ()=0
	Perform factory reset on Block. More...

virtual void	blockReset ()=0
	Reset this Block. More...

virtual bool	setName (const juce::String &name)=0
	Set Block name. More...

virtual void	setLogger (std::function< void(const Block &block, const juce::String &)> loggingCallback)=0
	Allows the user to provide a function that will receive log messages from the block. More...

virtual bool	sendFirmwareUpdatePacket (const juce::uint8 *data, juce::uint8 size, std::function< void(juce::uint8, juce::uint32)> packetAckCallback)=0
	Sends a firmware update packet to a block, and waits for a reply. More...

virtual void	addDataInputPortListener (DataInputPortListener *)
	Adds a new listener for the data input port. More...

virtual void	removeDataInputPortListener (DataInputPortListener *)
	Removes a listener for the data input port. More...

virtual void	sendMessage (const void *messageData, size_t messageSize)=0
	Sends a message to the block. More...

Static Public Member Functions
static bool	isControlBlock (Block::Type)
	Returns true if Block::Type is a control block. More...

Public Attributes
const juce::String	serialNumber
	The Block's serial number. More...

juce::String	versionNumber
	The Block's version number. More...

juce::String	name
	The Block's name. More...

const UID	uid
	This Block's UID. More...

ProgramPersistency	programPersistency { ProgramPersistency::setAsTemp }

Protected Member Functions
	Block (const juce::String &serialNumberToUse)

	Block (const juce::String &serial, const juce::String &version, const juce::String &name)

Protected Attributes
juce::ListenerList< ProgramLoadedListener >	programLoadedListeners

juce::ListenerList< ProgramEventListener >	programEventListeners

juce::ListenerList< ConfigItemListener >	configItemListeners

juce::ListenerList< DataInputPortListener >	dataInputPortListeners

Classes
struct	BlockArea
	A simple struct representing the area of a block. More...

struct	ConfigItemListener
	Listener interface to be informed of block config changes. More...

struct	ConfigMetaData
	Metadata for a given config item. More...

struct	ConnectionPort
	These are the edge-connectors that a device may have. More...

struct	DataInputPortListener
	Interface for objects listening to input data port. More...

struct	Program
	A program that can be loaded onto a block. More...

struct	ProgramEventListener
	Interface for objects listening to custom program events. More...

struct	ProgramEventMessage
	A message that can be sent to the currently loaded program. More...

struct	ProgramLoadedListener
	Listener interface to be informed of program loaded events. More...

Public Types
enum	Type { unknown = 0 , lightPadBlock , liveBlock , loopBlock , developerControlBlock , touchBlock , seaboardBlock , lumiKeysBlock }
	The different block types. More...

enum class	ProgramPersistency { setAsTemp , setAsDefault }
	Determines whether set program will be a temporary or default script saved to flash. More...

using	Ptr = juce::ReferenceCountedObjectPtr< Block >
	The Block class is reference-counted, so always use a Block::Ptr when you are keeping references to them. More...

using	Array = juce::ReferenceCountedArray< Block >
	The Block class is reference-counted, so Block::Array is useful when you are storing lists of them. More...

using	UID = juce::uint64
	This type is used for the unique block identifier. More...

using	Timestamp = juce::uint32
	This type is used for timestamping events. More...

Constructor & Destructor Documentation

◆ ~Block()

Block::~Block ( )

override

Destructor.

◆ Block() [1/2]

Block::Block ( const juce::String & serialNumberToUse )

protected

◆ Block() [2/2]

Block::Block	(	const juce::String &	serial,
		const juce::String &	version,
		const juce::String &	name
	)

protected

Member Function Documentation

◆ operator==()

bool Block::operator== ( const Block & other ) const

noexcept

Two blocks are considered equal if they have the same UID.

References uid.

◆ operator!=()

bool Block::operator!= ( const Block & other ) const

noexcept

Two blocks are considered equal if they have the same UID.

References uid.

◆ getType()

virtual Type Block::getType ( ) const

pure virtual

Returns the type of this device.

See also: Block::Type

◆ isControlBlock() [1/2]

bool Block::isControlBlock ( ) const

Returns true if this a control block.

◆ isControlBlock() [2/2]

static bool Block::isControlBlock ( Block::Type )

static

Returns true if Block::Type is a control block.

◆ getDeviceDescription()

virtual juce::String Block::getDeviceDescription ( ) const

pure virtual

Returns a human-readable description of this device type.

◆ getBatteryLevel()

virtual float Block::getBatteryLevel ( ) const

pure virtual

Returns the battery level in the range 0.0 to 1.0.

◆ isBatteryCharging()

virtual bool Block::isBatteryCharging ( ) const

pure virtual

Returns true if the battery is charging.

◆ isConnected()

virtual bool Block::isConnected ( ) const

pure virtual

Returns true if this block is connected and active.

◆ getConnectionTime()

virtual juce::Time Block::getConnectionTime ( ) const

pure virtual

Returns the time this block object was connected to the topology.

Only valid when isConnected == true.

See also: Block::isConnected

◆ isConnectedViaBluetooth()

virtual bool Block::isConnectedViaBluetooth ( ) const

pure virtual

Returns true if this block or the master block this block is connected to, is connected via bluetooth.

Only valid when isConnected == true.

See also: Block::isConnected, Block::isMasterBlock

◆ isMasterBlock()

virtual bool Block::isMasterBlock ( ) const

pure virtual

Returns true if this block is directly connected to the application, as opposed to only being connected to a different block via a connection port.

See also: Block::ConnectionPort

◆ getConnectedMasterUID()

virtual UID Block::getConnectedMasterUID ( ) const

pure virtual

Returns the UID of the master block this block is connected to.

◆ getWidth()

virtual int Block::getWidth ( ) const

pure virtual

Returns the width of the device in logical device units.

◆ getHeight()

virtual int Block::getHeight ( ) const

pure virtual

Returns the height of the device in logical device units.

◆ isHardwareBlock()

virtual bool Block::isHardwareBlock ( ) const

pure virtual

Returns true if the device is a physical hardware block (i.e.

not a virtual block).

◆ getMillimetersPerUnit()

virtual float Block::getMillimetersPerUnit ( ) const

pure virtual

Returns the length of one logical device unit as physical millimeters.

◆ getBlockAreaWithinLayout()

virtual BlockArea Block::getBlockAreaWithinLayout ( ) const

pure virtual

Returns the area that this block covers within the layout of the group as a whole.

The coordinates are in logical block units, and are relative to the origin, which is the master block's top-left corner.

◆ getRotation()

virtual int Block::getRotation ( ) const

pure virtual

Returns the rotation of this block relative to the master block in 90 degree steps clockwise.

◆ getLEDGrid()

virtual LEDGrid* Block::getLEDGrid ( ) const

pure virtual

If this block has a grid of LEDs, this will return an object to control it.

Note that the pointer that is returned belongs to this object, and the caller must neither delete it or use it after the lifetime of this Block object has finished. If there are no LEDs, then this method will return nullptr.

◆ getLEDRow()

virtual LEDRow* Block::getLEDRow ( )

pure virtual

If this block has a row of LEDs, this will return an object to control it.

Note that the pointer that is returned belongs to this object, and the caller must neither delete it or use it after the lifetime of this Block object has finished. If there are no LEDs, then this method will return nullptr.

◆ getStatusLights()

virtual juce::Array<StatusLight*> Block::getStatusLights ( ) const

pure virtual

If this block has any status LEDs, this will return an array of objects to control them.

Note that the objects in the array belong to this Block object, and the caller must neither delete them or use them after the lifetime of this Block object has finished.

◆ getTouchSurface()

virtual TouchSurface* Block::getTouchSurface ( ) const

pure virtual

If this block has a pressure-sensitive surface, this will return an object to access its data.

Note that the pointer returned does is owned by this object, and the caller must neither delete it or use it after the lifetime of this Block object has finished. If the device is not touch-sensitive, then this method will return nullptr.

◆ getButtons()

virtual juce::Array<ControlButton*> Block::getButtons ( ) const

pure virtual

If this block has any control buttons, this will return an array of objects to control them.

Note that the objects in the array belong to this Block object, and the caller must neither delete them or use them after the lifetime of this Block object has finished.

◆ supportsGraphics()

virtual bool Block::supportsGraphics ( ) const

pure virtual

This returns true if the block supports generating graphics by drawing into a JUCE Graphics context.

This should only be true for virtual on-screen blocks; hardware blocks will instead use the LED Grid for visuals.

◆ getPorts()

virtual juce::Array<ConnectionPort> Block::getPorts ( ) const

pure virtual

Returns a list of the connectors that this device has.

◆ setProgram()

virtual juce::Result Block::setProgram	(	std::unique_ptr< Program >	,
		ProgramPersistency	persistency = `ProgramPersistency::setAsTemp`
	)

pure virtual

Sets the Program to run on this block.

The supplied Program's lifetime will be managed by this class, so do not use the Program in other places in your code.

Optional parameter to determine if program is set temporarily or saved to flash as the default prgram./

◆ getProgram()

virtual Program* Block::getProgram ( ) const

pure virtual

Returns a pointer to the currently loaded program.

◆ addProgramLoadedListener()

void Block::addProgramLoadedListener ( ProgramLoadedListener * )

Adds a new listener for program load completions.

◆ removeProgramLoadedListener()

void Block::removeProgramLoadedListener ( ProgramLoadedListener * )

Removes a listener for program load completions.

◆ sendProgramEvent()

virtual void Block::sendProgramEvent ( const ProgramEventMessage & )

pure virtual

Sends a message to the currently loaded program.

To receive the message the program must provide a littlefoot function called handleMessage with the following form:

void handleMessage (int param1, int param2, int param3)
{
    // Do something with the two integer parameters that the app has sent...
}

◆ addProgramEventListener()

void Block::addProgramEventListener ( ProgramEventListener * )

Adds a new listener for custom program events from the block.

◆ removeProgramEventListener()

void Block::removeProgramEventListener ( ProgramEventListener * )

Removes a listener for custom program events from the block.

◆ getMemorySize()

virtual juce::uint32 Block::getMemorySize ( )

pure virtual

Returns the overall memory of the block.

◆ getHeapMemorySize()

virtual juce::uint32 Block::getHeapMemorySize ( )

pure virtual

Returns the size of the data block that setDataByte and other functions can write to.

◆ setDataByte()

virtual void Block::setDataByte	(	size_t	offset,
		juce::uint8	value
	)

pure virtual

Sets a single byte on the littlefoot heap.

Referenced by setData().

◆ setDataBytes()

virtual void Block::setDataBytes	(	size_t	offset,
		const void *	data,
		size_t	num
	)

pure virtual

Sets multiple bytes on the littlefoot heap.

◆ setDataBits()

virtual void Block::setDataBits	(	juce::uint32	startBit,
		juce::uint32	numBits,
		juce::uint32	value
	)

pure virtual

Sets multiple bits on the littlefoot heap.

◆ setData()

template<typename Type >

void Block::setData	(	juce::uint32	offset,
		Type	value
	)

Sets a single, 32 bit or less, value on the littlefoot heap.

References setDataByte().

◆ getDataByte()

virtual juce::uint8 Block::getDataByte ( size_t offset )

pure virtual

Gets a byte from the littlefoot heap.

◆ saveProgramAsDefault()

virtual void Block::saveProgramAsDefault ( )

pure virtual

Sets the current program as the block's default state.

◆ resetProgramToDefault()

virtual void Block::resetProgramToDefault ( )

pure virtual

Resets the loaded program to the block's default state.

◆ addConfigItemListener()

void Block::addConfigItemListener ( ConfigItemListener * )

Adds a new listener for config item changes.

◆ removeConfigItemListener()

void Block::removeConfigItemListener ( ConfigItemListener * )

Removes a listener for config item changes.

◆ getMaxConfigIndex()

virtual juce::uint32 Block::getMaxConfigIndex ( )

pure virtual

Returns the maximum number of config items available.

◆ isValidUserConfigIndex()

virtual bool Block::isValidUserConfigIndex ( juce::uint32 item )

pure virtual

Determine if this is a valid config item index.

◆ getLocalConfigValue()

virtual juce::int32 Block::getLocalConfigValue ( juce::uint32 item )

pure virtual

Get local config item value.

◆ setLocalConfigValue()

virtual void Block::setLocalConfigValue	(	juce::uint32	item,
		juce::int32	value
	)

pure virtual

Set local config item value.

◆ setLocalConfigRange()

virtual void Block::setLocalConfigRange	(	juce::uint32	item,
		juce::int32	min,
		juce::int32	max
	)

pure virtual

Set local config item range.

◆ setLocalConfigItemActive()

virtual void Block::setLocalConfigItemActive	(	juce::uint32	item,
		bool	isActive
	)

pure virtual

Set if config item is active or not.

◆ isLocalConfigItemActive()

virtual bool Block::isLocalConfigItemActive ( juce::uint32 item )

pure virtual

Determine if config item is active or not.

◆ getLocalConfigMetaData()

virtual ConfigMetaData Block::getLocalConfigMetaData ( juce::uint32 item )

pure virtual

Get config item metadata.

◆ requestFactoryConfigSync()

virtual void Block::requestFactoryConfigSync ( )

pure virtual

Request sync of factory config with block.

◆ resetConfigListActiveStatus()

virtual void Block::resetConfigListActiveStatus ( )

pure virtual

Reset all items active status.

◆ factoryReset()

virtual void Block::factoryReset ( )

pure virtual

Perform factory reset on Block.

◆ blockReset()

virtual void Block::blockReset ( )

pure virtual

Reset this Block.

◆ setName()

virtual bool Block::setName ( const juce::String & name )

pure virtual

Set Block name.

◆ setLogger()

virtual void Block::setLogger ( std::function< void(const Block &block, const juce::String &)> loggingCallback )

pure virtual

Allows the user to provide a function that will receive log messages from the block.

◆ sendFirmwareUpdatePacket()

virtual bool Block::sendFirmwareUpdatePacket	(	const juce::uint8 *	data,
		juce::uint8	size,
		std::function< void(juce::uint8, juce::uint32)>	packetAckCallback
	)

pure virtual

Sends a firmware update packet to a block, and waits for a reply.

Returns an error code.

◆ addDataInputPortListener()

virtual void Block::addDataInputPortListener ( DataInputPortListener * )

virtual

Adds a new listener for the data input port.

◆ removeDataInputPortListener()

virtual void Block::removeDataInputPortListener ( DataInputPortListener * )

virtual

Removes a listener for the data input port.

◆ sendMessage()

virtual void Block::sendMessage	(	const void *	messageData,
		size_t	messageSize
	)

pure virtual

Sends a message to the block.

Member Typedef Documentation

◆ Ptr

using Block::Ptr = juce::ReferenceCountedObjectPtr<Block>

The Block class is reference-counted, so always use a Block::Ptr when you are keeping references to them.

◆ Array

using Block::Array = juce::ReferenceCountedArray<Block>

The Block class is reference-counted, so Block::Array is useful when you are storing lists of them.

◆ UID

using Block::UID = juce::uint64

This type is used for the unique block identifier.

◆ Timestamp

using Block::Timestamp = juce::uint32

This type is used for timestamping events.

It represents a number of milliseconds since the block device was booted.

Member Enumeration Documentation

◆ Type

enum Block::Type

The different block types.

See also: Block::getType()

Enumerator
unknown	Unknown block type.
lightPadBlock	Lightpad block type.
liveBlock	Live control block type.
loopBlock	Loop control block type.
developerControlBlock	Developer control block type.
touchBlock	Touch control block type.
seaboardBlock	Seaboard block type.
lumiKeysBlock	LUMI Keys block type

◆ ProgramPersistency

enum Block::ProgramPersistency

strong

Determines whether set program will be a temporary or default script saved to flash.

Enumerator
setAsTemp
setAsDefault

Member Data Documentation

◆ serialNumber

const juce::String Block::serialNumber

The Block's serial number.

◆ versionNumber

juce::String Block::versionNumber

The Block's version number.

◆ name

juce::String Block::name

The Block's name.

◆ uid

const UID Block::uid

This Block's UID.

This will be globally unique, and remains constant for a particular device.

Referenced by operator!=(), and operator==().

◆ programPersistency

ProgramPersistency Block::programPersistency { ProgramPersistency::setAsTemp }

◆ programLoadedListeners

juce::ListenerList<ProgramLoadedListener> Block::programLoadedListeners

protected

◆ programEventListeners

juce::ListenerList<ProgramEventListener> Block::programEventListeners

protected

◆ configItemListeners

juce::ListenerList<ConfigItemListener> Block::configItemListeners

protected

◆ dataInputPortListeners

juce::ListenerList<DataInputPortListener> Block::dataInputPortListeners

protected

The documentation for this class was generated from the following file:

roli_Block.h

Description

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Classes

Public Types

Constructor & Destructor Documentation

◆ ~Block()

◆ Block() [1/2]

◆ Block() [2/2]

Member Function Documentation

◆ operator==()

◆ operator!=()

◆ getType()

◆ isControlBlock() [1/2]

◆ isControlBlock() [2/2]

◆ getDeviceDescription()

◆ getBatteryLevel()

◆ isBatteryCharging()

◆ isConnected()

◆ getConnectionTime()

◆ isConnectedViaBluetooth()

◆ isMasterBlock()

◆ getConnectedMasterUID()

◆ getWidth()

◆ getHeight()

◆ isHardwareBlock()

◆ getMillimetersPerUnit()

◆ getBlockAreaWithinLayout()

◆ getRotation()

◆ getLEDGrid()

◆ getLEDRow()

◆ getStatusLights()

◆ getTouchSurface()

◆ getButtons()

◆ supportsGraphics()

◆ getPorts()

◆ setProgram()

◆ getProgram()

◆ addProgramLoadedListener()

◆ removeProgramLoadedListener()

◆ sendProgramEvent()

◆ addProgramEventListener()

◆ removeProgramEventListener()

◆ getMemorySize()

◆ getHeapMemorySize()

◆ setDataByte()

◆ setDataBytes()

◆ setDataBits()

◆ setData()

◆ getDataByte()

◆ saveProgramAsDefault()

◆ resetProgramToDefault()

◆ addConfigItemListener()

◆ removeConfigItemListener()

◆ getMaxConfigIndex()

◆ isValidUserConfigIndex()

◆ getLocalConfigValue()

◆ setLocalConfigValue()

◆ setLocalConfigRange()

◆ setLocalConfigItemActive()

◆ isLocalConfigItemActive()

◆ getLocalConfigMetaData()

◆ requestFactoryConfigSync()

◆ resetConfigListActiveStatus()

◆ factoryReset()

◆ blockReset()

◆ setName()

◆ setLogger()

◆ sendFirmwareUpdatePacket()

◆ addDataInputPortListener()

◆ removeDataInputPortListener()

◆ sendMessage()

Member Typedef Documentation

◆ Ptr

◆ Array

◆ UID

◆ Timestamp