me.legrange.panstamp

Class Network

java.lang.Object

me.legrange.panstamp.Network

All Implemented Interfaces:

AutoCloseable

public final class Network
extends Object
implements AutoCloseable

A gateway connecting a panStamp network to your code using the SWAP modem supplied.

Since:

1.0

Author:

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

Method Summary

Modifier and Type	Method and Description
void	addDevice(PanStamp ps) Add a user-created device to the panStamp network.
void	addListener(NetworkListener l) add listener to receive new device events
void	close() Disconnect the connection and close the network
static Network	create(SwapModem modem) Create a new network with the given pre-existing SWAP modem.
int	getChannel() Get the frequency channel
PanStamp	getDevice(int address) return the device with the given name
int	getDeviceAddress() get the gateway panStamp's address
DeviceLibrary	getDeviceLibrary() Return the device library being used to lookup device definitions.
List<PanStamp>	getDevices() return all the devices associated with this network
DeviceStateStore	getDeviceStore() Return the device store used to save device state.
int	getNetworkId() return the network ID for the network supported by this network
int	getSecurityOption() Get the security option
SwapModem	getSWAPModem() return the SWAP modem to gain access to the lower layer
boolean	hasDevice(int address) use to check if a device with the given address is known
boolean	isOpen() Check if the network is open (is connected to a panStamp network).
void	open() Open the network.
static Network	openSerial(String port, int baud) Create a new serial network (network attached to a serial port) with the given port and speed, and with the default device library and data store.
static Network	openTcp(String host, int port) Create a new TCP/IP network (network attached to a remote TCP service) with the given host and port, and with the default device library and data store.
void	removeDevice(int address) Removes the device with the given address from the network
void	removeListener(NetworkListener l) remove a listener from the network
void	setChannel(int channel) Set the frequency channel
void	setDeviceAddress(int addr) Set the device address for the network panStamp
void	setDeviceLibrary(DeviceLibrary lib) Set the device library used to lookup device definitions.
void	setDeviceStore(DeviceStateStore store) Set the device store to use to lookup persisted device registers.
void	setNetworkId(int id) Set the network ID for the network accessed by this network
void	setSecurityOption(int secOpt) Set the security option

Methods inherited from class java.lang.Object

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

Method Detail

openSerial

public static Network openSerial(String port,
                                 int baud)
                          throws NetworkException

Create a new serial network (network attached to a serial port) with the given port and speed, and with the default device library and data store.

Parameters:

port - The serial port to open, for example COM1 or /dev/ttyS0

baud - The speed at which to open it, for example 34800

Returns:

The newly created network.

Throws:

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

openTcp

public static Network openTcp(String host,
                              int port)
                       throws NetworkException

Create a new TCP/IP network (network attached to a remote TCP service) with the given host and port, and with the default device library and data store.

Parameters:

host - The host name to which to connect, for example 'localhost' or '192.168.1.1'

port - The TCP port to which to connect.

Returns:

The newly created network

Throws:

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

create

public static Network create(SwapModem modem)

Create a new network with the given pre-existing SWAP modem.

Parameters:

modem - The SWAP modem to use in the network.

Returns:

The newly created network.

isOpen

public boolean isOpen()

Check if the network is open (is connected to a panStamp network).

Returns:

True if the network is running.

open

public void open()
          throws NetworkException

Open the network. This will open the underlying modem and internal processes that are needed.

Throws:

NetworkException - Thrown if there is a problem opening the modem.

close

public void close()
           throws ModemException

Disconnect the connection and close the network

Specified by:

close in interface AutoCloseable

Throws:

ModemException - Thrown if there is a problem closing the modem supporting the network.

hasDevice

public boolean hasDevice(int address)

use to check if a device with the given address is known

Parameters:

address - Address of the device we're looking for.

Returns:

True if a device with the given address is known

getDevice

public PanStamp getDevice(int address)
                   throws NodeNotFoundException

return the device with the given name

Parameters:

address - Address of device to fins

Returns:

The device

Throws:

NodeNotFoundException - Thrown if the device with the given address cannot be found.

getDevices

public List<PanStamp> getDevices()

return all the devices associated with this network

Returns:

The list of devices

addDevice

public void addDevice(PanStamp ps)

Add a user-created device to the panStamp network.

Parameters:

ps - The device to add.

removeDevice

public void removeDevice(int address)

Removes the device with the given address from the network

Parameters:

address - The address of the device to remove.

addListener

public void addListener(NetworkListener l)

add listener to receive new device events

Parameters:

l - The listener to add

removeListener

public void removeListener(NetworkListener l)

remove a listener from the network

Parameters:

l - The listener to remove

getSWAPModem

public SwapModem getSWAPModem()

return the SWAP modem to gain access to the lower layer

Returns:

The SWAP modem supporting this network

getDeviceLibrary

public DeviceLibrary getDeviceLibrary()

Return the device library being used to lookup device definitions.

Returns:

The current library.

getDeviceStore

public DeviceStateStore getDeviceStore()

Return the device store used to save device state.

Returns:

The current store.

setDeviceLibrary

public void setDeviceLibrary(DeviceLibrary lib)

Set the device library used to lookup device definitions.

Parameters:

lib - The library to use.

setDeviceStore

public void setDeviceStore(DeviceStateStore store)

Set the device store to use to lookup persisted device registers.

Parameters:

store - The store to use.

getNetworkId

public int getNetworkId()
                 throws ModemException

return the network ID for the network supported by this network

Returns:

The network ID

Throws:

ModemException - Thrown if there is problem determining the network ID

getChannel

public int getChannel()
               throws ModemException

Get the frequency channel

Returns:

The channel

Throws:

ModemException - Thrown if the channel could not be determined.

getDeviceAddress

public int getDeviceAddress()
                     throws ModemException

get the gateway panStamp's address

Returns:

the network address

Throws:

ModemException - Thrown if the device address could not be determined.

getSecurityOption

public int getSecurityOption()

Get the security option

Returns:

the security option value.

setNetworkId

public void setNetworkId(int id)
                  throws NetworkException

Set the network ID for the network accessed by this network

Parameters:

id - The network ID

Throws:

NetworkException - thrown if there is a problem setting the network ID

setDeviceAddress

public void setDeviceAddress(int addr)
                      throws NetworkException

Set the device address for the network panStamp

Parameters:

addr - Address to set for the modem device.

Throws:

NetworkException - Thrown if there is a problem setting the modem device address

setChannel

public void setChannel(int channel)
                throws NetworkException

Set the frequency channel

Parameters:

channel - The channel to use.

Throws:

NetworkException - Thrown if there is an error setting the channel.

setSecurityOption

public void setSecurityOption(int secOpt)

Set the security option

Parameters:

secOpt - Security option to use.