Package org.openremote.agent.protocol.bluetooth.mesh

Class Scene

java.lang.Object

org.openremote.agent.protocol.bluetooth.mesh.Scene

public class Scene
extends Object

Class definitions for creating scenes in a mesh network

Field Summary

Fields

Modifier and Type	Field	Description
protected List<Integer>	addresses

Constructor Summary

Constructors

Constructor	Description
Scene(int number, String meshUuid)
Scene(int number, List<Integer> addresses, String meshUuid)

Method Summary

Modifier and Type	Method	Description
static String	formatSceneNumber(int number, boolean add0x)	Formats the scene number in to a 4 character hexadecimal String
List<Integer>	getAddresses()	Returns the address of the scene
String	getMeshUuid()
String	getName()	Friendly name of the scene
int	getNumber()
static boolean	isValidSceneNumber(int sceneNumber)	Validates the scene number
void	setAddresses(List<Integer> addresses)	Sets addresses for this group
void	setName(String name)	Sets a friendly name to a scene
void	setNumber(int number)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

addresses

protected List<Integer> addresses

Constructor Details

Scene

public Scene(int number,
 String meshUuid)

Scene

public Scene(int number,
 List<Integer> addresses,
 String meshUuid)

Method Details

getMeshUuid

public String getMeshUuid()

getName

public String getName()

Friendly name of the scene

Returns:

name

setName

public void setName(String name)

Sets a friendly name to a scene

Parameters:

name - friendly name

getAddresses

public List<Integer> getAddresses()

Returns the address of the scene

Returns:

2 byte address

setAddresses

public void setAddresses(List<Integer> addresses)

Sets addresses for this group

Parameters:

addresses - list of addresses

getNumber

public int getNumber()

setNumber

public void setNumber(int number)

isValidSceneNumber

public static boolean isValidSceneNumber(int sceneNumber)

Validates the scene number

Parameters:

sceneNumber - Scene number

Returns:

true if is a valid or throws an IllegalArgument exception

formatSceneNumber

public static String formatSceneNumber(int number,
 boolean add0x)

Formats the scene number in to a 4 character hexadecimal String

Parameters:

number - Scene number

add0x - Sets "0x" as prefix if set to true or false otherwise

toString

public String toString()

Overrides:

toString in class Object