me.legrange.panstamp.definition

Interface DeviceDefinition

public interface DeviceDefinition

A panStamp device configuration. Typically loaded from XML, but a user can implement their own version of this.

Since:

1.0

Author:

Gideon le Grange https://github.com/GideonLeGrange *

Method Summary

Modifier and Type	Method and Description
DeveloperDefinition	getDeveloper() Get the developer owning this device definition
int	getId() Get the definition ID (product ID)
String	getLabel() Get the label (more informative description / human readable description) of the device / product.
String	getName() Get the name of the device or product
String	getProduct() Get the product description of the device / product.
RegisterDefinition	getRegister(int id) Return the register definition for the register with the given ID.
List<RegisterDefinition>	getRegisters() Get the definitions for the registers defined in the device configuration.
boolean	hasRegister(int id) Check if the device definition contains a register definition for the given register ID.
boolean	isPowerDownMode() Get the power down mode of this device.

Method Detail

getId

int getId()

Get the definition ID (product ID)

Returns:

The product ID.

getDeveloper

DeveloperDefinition getDeveloper()

Get the developer owning this device definition

Returns:

The developer object.

getName

String getName()

Get the name of the device or product

Returns:

The name.

getLabel

String getLabel()

Get the label (more informative description / human readable description) of the device / product. This comes from the label attribute in the devices.xml file.

Returns:

The label.

getProduct

String getProduct()

Get the product description of the device / product. This comes from the product tag in the device's specific XML file.

Returns:

The label.

isPowerDownMode

boolean isPowerDownMode()

Get the power down mode of this device.

Returns:

True if the definition specifies that the device operates in power down mode.

getRegisters

List<RegisterDefinition> getRegisters()

Get the definitions for the registers defined in the device configuration.

Returns:

The list of register definitions.

hasRegister

boolean hasRegister(int id)

Check if the device definition contains a register definition for the given register ID.

Parameters:

id - The ID of the register requested.

Returns:

True if the register is defined.

getRegister

RegisterDefinition getRegister(int id)

Return the register definition for the register with the given ID.

Parameters:

id - The ID of the register requested.

Returns:

The register definition.