me.legrange.panstamp

Class PanStamp

java.lang.Object

me.legrange.panstamp.PanStamp

public final class PanStamp
extends Object

An implementation of a panStamp abstraction. Instances of this class represent instances of panStamp devices connected to the network behind the gateway.

Since:

1.0

Author:

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

Constructor Summary

Constructors

Constructor and Description
PanStamp(Network gw, int address) create a new mote for the given address in the given network

Method Summary

Modifier and Type	Method and Description
void	addListener(PanStampListener l) add an event listener
int	getAddress() Get the address of this device.
int	getChannel() Return the network channel
Network	getGateway() Get the gateway this device is attached to.
int	getManufacturerId() Get the device manufacturer id.
String	getName() Get the device name (as defined by the endpoint definition).
int	getNetwork() Return the network ID
int	getProductId() Get the device product id.
Register	getRegister(int id) Get the register with the given register ID for this device.
List<Register>	getRegisters() Get the list of registers defined for this device
int	getSecurityOption() Return the current security option
int	getSyncState() Return the current sync state
int	getTxInterval() Return the transmit interval
boolean	hasRegister(int id) Determine if the device has a register with the given ID.
void	removeListener(PanStampListener l) remove an event listener
void	setAddress(int addr) Set the address of the panStamp
void	setChannel(int channel) Set the network channel of the device
void	setNetwork(int network) Set the network id of the device
void	setSecurityOption(int option) Set the security option of the device.
void	setTxInterval(int txInterval) Set the transmit interval (in seconds) of the device.

Methods inherited from class java.lang.Object

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

Constructor Detail

PanStamp

public PanStamp(Network gw,
                int address)
         throws NetworkException

create a new mote for the given address in the given network

Parameters:

gw - The gateway to which this device is connected

address - The address of the device

Throws:

NetworkException - Thrown if there is a problem creating the device.

Method Detail

getAddress

public int getAddress()

Get the address of this device.

Returns:

The address

getChannel

public int getChannel()
               throws NetworkException

Return the network channel

Returns:

The channel

Throws:

NetworkException - Thrown if there is a problem getting the channel value

getTxInterval

public int getTxInterval()
                  throws NetworkException

Return the transmit interval

Returns:

The interval

Throws:

NetworkException - Thrown if there is a problem getting the interval value

getSecurityOption

public int getSecurityOption()
                      throws NetworkException

Return the current security option

Returns:

The security option

Throws:

NetworkException - Thrown if there is a problem getting the security option value

getSyncState

public int getSyncState()
                 throws NetworkException

Return the current sync state

Returns:

The sync state

Throws:

NetworkException

Since:

1.2

getNetwork

public int getNetwork()
               throws NetworkException

Return the network ID

Returns:

The network ID

Throws:

NetworkException - Thrown if there is a problem getting the network ID value

setAddress

public void setAddress(int addr)
                throws NetworkException

Set the address of the panStamp

Parameters:

addr - The address to set

Throws:

NetworkException - Thrown if there is a problem reading the interval.

setNetwork

public void setNetwork(int network)
                throws NetworkException

Set the network id of the device

Parameters:

network - The network id

Throws:

NetworkException - Thrown if there is a problem setting the ID

setChannel

public void setChannel(int channel)
                throws NetworkException

Set the network channel of the device

Parameters:

channel - The channel to set.

Throws:

NetworkException - Thrown if there is a problem setting the channel

setSecurityOption

public void setSecurityOption(int option)
                       throws NetworkException

Set the security option of the device.

Parameters:

option - The security option to set.

Throws:

NetworkException - Thrown if there is a problem setting the option.

setTxInterval

public void setTxInterval(int txInterval)
                   throws NetworkException

Set the transmit interval (in seconds) of the device.

Parameters:

txInterval - The interval to set.

Throws:

NetworkException - Thrown if there is a problem setting the interval.

getManufacturerId

public int getManufacturerId()
                      throws NetworkException

Get the device manufacturer id.

Returns:

The manufacturer Id

Throws:

NetworkException - Thrown if there is a problem reading the id.

getProductId

public int getProductId()
                 throws NetworkException

Get the device product id.

Returns:

The product Id

Throws:

NetworkException - Thrown if there is a problem reading the id.

getGateway

public Network getGateway()

Get the gateway this device is attached to.

Returns:

The gateway

getName

public String getName()

Get the device name (as defined by the endpoint definition).

Returns:

The name of the device

getRegister

public Register getRegister(int id)

Get the register with the given register ID for this device.

Parameters:

id - ID of register to return

Returns:

the register for the given id

getRegisters

public List<Register> getRegisters()

Get the list of registers defined for this device

Returns:

The list of registers.

hasRegister

public boolean hasRegister(int id)

Determine if the device has a register with the given ID.

Parameters:

id - The id of the register required.

Returns:

True if the panStamp has the register.

addListener

public void addListener(PanStampListener l)

add an event listener

Parameters:

l - The listener to add

removeListener

public void removeListener(PanStampListener l)

remove an event listener

Parameters:

l - The listener to remove