Index (panStamp Device Library 1.2 API)

A C D E F G H I L M N O P R S T U V

A

AbstractEndpointListener<T> - Class in me.legrange.panstamp.event: An abstract implementation for an EndpointListener that developers can extend if they only what to implement one method in the EndpointListener interface.
AbstractEndpointListener() - Constructor for class me.legrange.panstamp.event.AbstractEndpointListener
AbstractNetworkListener - Class in me.legrange.panstamp.event: An abstract implementation for a NetworkListener that developers can extend if they only what to implement one method in the GatewayListener interface.
AbstractNetworkListener() - Constructor for class me.legrange.panstamp.event.AbstractNetworkListener
AbstractPanStampListener - Class in me.legrange.panstamp.event: An abstract implementation for a PanStampListener that developers can extend if they only what to implement one method in the PanStampListener interface.
AbstractPanStampListener() - Constructor for class me.legrange.panstamp.event.AbstractPanStampListener
AbstractRegisterListener - Class in me.legrange.panstamp.event: An abstract implementation for a RegisterListener that developers can extend if they only what to implement one method in the RegisterListener interface.
AbstractRegisterListener() - Constructor for class me.legrange.panstamp.event.AbstractRegisterListener
addDevice(PanStamp) - Method in class me.legrange.panstamp.Network: Add a user-created device to the panStamp network.
addListener(EndpointListener<T>) - Method in interface me.legrange.panstamp.Endpoint: Add a listener to the endpoint.
addListener(NetworkListener) - Method in class me.legrange.panstamp.Network: add listener to receive new device events
addListener(PanStampListener) - Method in class me.legrange.panstamp.PanStamp: add an event listener
addListener(RegisterListener) - Method in class me.legrange.panstamp.Register: Add a listener to receive register updates
addListener(MessageListener) - Method in class me.legrange.swap.SerialModem
addListener(MessageListener) - Method in interface me.legrange.swap.SwapModem: add a message listener to receive messages
addListener(MessageListener) - Method in class me.legrange.swap.tcp.TcpModem

C

ClassLoaderLibrary - Class in me.legrange.panstamp.xml: A device library that uses the Java class loader to load XML definitions.
ClassLoaderLibrary() - Constructor for class me.legrange.panstamp.xml.ClassLoaderLibrary
close() - Method in class me.legrange.panstamp.Network: Disconnect the connection and close the network
close() - Method in class me.legrange.swap.SerialModem
close() - Method in interface me.legrange.swap.SwapModem: disconnect and close the modem
close() - Method in class me.legrange.swap.tcp.TcpModem
close() - Method in class me.legrange.swap.tcp.TcpServer
CompoundDeviceLibrary - Class in me.legrange.panstamp.definition: A device library implementation that searches through one or more other device libraries for a device definition.
CompoundDeviceLibrary(DeviceLibrary...) - Constructor for class me.legrange.panstamp.definition.CompoundDeviceLibrary
ConfigDeviceStateStore - Class in example
ConfigDeviceStateStore() - Constructor for class example.ConfigDeviceStateStore
create(SwapModem) - Static method in class me.legrange.panstamp.Network: Create a new network with the given pre-existing SWAP modem.

D

DecodingException - Exception in me.legrange.swap: Thrown when a packet decoding error occurs.
DecodingException(String) - Constructor for exception me.legrange.swap.DecodingException
DecodingException(String, Throwable) - Constructor for exception me.legrange.swap.DecodingException
DefinitionException - Exception in me.legrange.panstamp.definition: Thrown when there is a problem with panStamp device definitions.
DefinitionException(String) - Constructor for exception me.legrange.panstamp.definition.DefinitionException
DefinitionException(String, Throwable) - Constructor for exception me.legrange.panstamp.definition.DefinitionException
DeveloperDefinition - Interface in me.legrange.panstamp.definition: The object represents the information associated with a panStamp developer in the device XML tree.
DeviceDefinition - Interface in me.legrange.panstamp.definition: A panStamp device configuration.
deviceDetected(Network, PanStamp) - Method in class me.legrange.panstamp.event.AbstractNetworkListener
deviceDetected(Network, PanStamp) - Method in interface me.legrange.panstamp.NetworkListener: A previously unknown device was detected on the SWAP network.
DeviceLibrary - Interface in me.legrange.panstamp: A device library can be implemented to find a device definition based on a panStamp's manufacturer ID and product ID.
DeviceNotFoundException - Exception in me.legrange.panstamp: Exception thrown if a panStamp device cannot be found
DeviceNotFoundException(String) - Constructor for exception me.legrange.panstamp.DeviceNotFoundException
DeviceNotFoundException(String, Throwable) - Constructor for exception me.legrange.panstamp.DeviceNotFoundException
deviceRemoved(Network, PanStamp) - Method in class me.legrange.panstamp.event.AbstractNetworkListener
deviceRemoved(Network, PanStamp) - Method in interface me.legrange.panstamp.NetworkListener: A device was removed from the network.
DeviceStateStore - Interface in me.legrange.panstamp: Application developers can implement this interface to add their preferred persistence implementation to the library.
Direction - Enum in me.legrange.panstamp.definition: Data flow direction defined.
doExampleCode(Network) - Method in class example.Example
doExampleCode(Network) - Method in class example.ListDevices
doExampleCode(Network) - Method in class example.NetworkEvents
doExampleCode(Network) - Method in class example.ReadAndSetNetworkInformation
doExampleCode(Network) - Method in class example.ReadAndSetPanStampInformation
doExampleCode(Network) - Method in class example.ReadTemps

E

Endpoint<T> - Interface in me.legrange.panstamp: A PanStamp endpoint
Endpoint.Type - Enum in me.legrange.panstamp: Type of value sent and/or received by an endpoint.
endpointAdded(Register, Endpoint) - Method in class me.legrange.panstamp.event.AbstractRegisterListener
endpointAdded(Register, Endpoint) - Method in interface me.legrange.panstamp.RegisterListener: An endpoint was added to a register.
EndpointDefinition - Interface in me.legrange.panstamp.definition: Definition of an endpoint as defined by XML.
EndpointListener<T> - Interface in me.legrange.panstamp: Listener that receives incoming data from an endpoint
EndpointNotFoundException - Exception in me.legrange.panstamp: Exception thrown in cases where it is expected to find an endpoint, and it doesn't exist.
EndpointNotFoundException(String) - Constructor for exception me.legrange.panstamp.EndpointNotFoundException
EndpointNotFoundException(String, Throwable) - Constructor for exception me.legrange.panstamp.EndpointNotFoundException
example - package example
Example - Class in example
Example() - Constructor for class example.Example

F

FileLibrary - Class in me.legrange.panstamp.xml: A device library that uses a directory with XML files to find device configurations.
FileLibrary(File) - Constructor for class me.legrange.panstamp.xml.FileLibrary
forTag(String) - Static method in enum me.legrange.panstamp.definition.Direction
forTag(String) - Static method in enum me.legrange.panstamp.definition.Type
function() - Method in enum me.legrange.swap.SwapMessage.Type

G

getAddress() - Method in class me.legrange.panstamp.PanStamp: Get the address of this device.
getBaud() - Method in class me.legrange.swap.SerialModem: Get the serial speed this modem connects at
getBitPos() - Method in class me.legrange.panstamp.definition.Position: Get the bit offset of the position.
getBits() - Method in class me.legrange.panstamp.definition.Size: Get the number of bits defined by this size.
getBytePos() - Method in class me.legrange.panstamp.definition.Position: Get the byte offset of the position.
getBytes() - Method in class me.legrange.panstamp.definition.Size: Get the number of bytes defined by this size.
getByteSize() - Method in interface me.legrange.panstamp.definition.RegisterDefinition: Get the size in bytes of this register.
getChannel() - Method in class me.legrange.panstamp.Network: Get the frequency channel
getChannel() - Method in class me.legrange.panstamp.PanStamp: Return the network channel
getChannel() - Method in class me.legrange.swap.ModemSetup
getDefault() - Method in interface me.legrange.panstamp.definition.ParameterDefinition: Get the default value of the parameter as per XML.
getDefault() - Method in interface me.legrange.panstamp.Parameter: returns the default value of the parameter as defined in XML.
getDeveloper() - Method in interface me.legrange.panstamp.definition.DeviceDefinition: Get the developer owning this device definition
getDevice(int) - Method in class me.legrange.panstamp.Network: return the device with the given name
getDevice() - Method in class me.legrange.panstamp.Register: Get the device to which this register belongs.
getDeviceAddress() - Method in class me.legrange.panstamp.Network: get the gateway panStamp's address
getDeviceAddress() - Method in class me.legrange.swap.ModemSetup
getDeviceDefinition(int, int) - Method in class me.legrange.panstamp.definition.CompoundDeviceLibrary
getDeviceDefinition(int, int) - Method in interface me.legrange.panstamp.DeviceLibrary: get the device definition based on the supplied manufacturer ID and product ID.
getDeviceLibrary() - Method in class me.legrange.panstamp.Network: Return the device library being used to lookup device definitions.
getDevices() - Method in class me.legrange.panstamp.Network: return all the devices associated with this network
getDeviceStore() - Method in class me.legrange.panstamp.Network: Return the device store used to save device state.
getDirection() - Method in interface me.legrange.panstamp.definition.EndpointDefinition: Get the direction of data flow for this endpoint.
getDirectory() - Method in class me.legrange.panstamp.xml.FileLibrary: Return the directory used for loading by this file loader.
getEndpoint(String) - Method in class me.legrange.panstamp.Register: return the endpoint for the given name
getEndpoints() - Method in interface me.legrange.panstamp.definition.RegisterDefinition: Get the endpoint definitions defined for this register definition.
getEndpoints() - Method in class me.legrange.panstamp.Register: return the endpoints defined for this register
getFactor() - Method in class me.legrange.panstamp.definition.Unit: The multiplication factor for the data.
getFunction() - Method in class me.legrange.swap.SerialMessage
getFunction() - Method in interface me.legrange.swap.SwapMessage: Get the SWAP function code for this message.
getFunction() - Method in class me.legrange.swap.UserMessage
getGateway() - Method in class me.legrange.panstamp.PanStamp: Get the gateway this device is attached to.
getHops() - Method in class me.legrange.swap.SerialMessage
getHops() - Method in interface me.legrange.swap.SwapMessage
getHops() - Method in class me.legrange.swap.UserMessage
getHost() - Method in class me.legrange.swap.tcp.TcpModem: Get the host the modem is connected to.
getId() - Method in interface me.legrange.panstamp.definition.DeveloperDefinition: Get the developer ID.
getId() - Method in interface me.legrange.panstamp.definition.DeviceDefinition: Get the definition ID (product ID)
getId() - Method in interface me.legrange.panstamp.definition.RegisterDefinition: Get the register ID of the register defined by this defintion.
getId() - Method in class me.legrange.panstamp.Register: return the register ID
getLabel() - Method in interface me.legrange.panstamp.definition.DeviceDefinition: Get the label (more informative description / human readable description) of the device / product.
getLqi() - Method in class me.legrange.swap.SerialMessage
getLqi() - Method in interface me.legrange.swap.SwapMessage
getLqi() - Method in class me.legrange.swap.UserMessage
getManufacturerId() - Method in class me.legrange.panstamp.PanStamp: Get the device manufacturer id.
getName() - Method in interface me.legrange.panstamp.definition.DeveloperDefinition: Get the developer name
getName() - Method in interface me.legrange.panstamp.definition.DeviceDefinition: Get the name of the device or product
getName() - Method in interface me.legrange.panstamp.definition.EndpointDefinition: Get the name of the endpoint.
getName() - Method in interface me.legrange.panstamp.definition.ParameterDefinition: Get then name of the parameter (as per XML).
getName() - Method in interface me.legrange.panstamp.definition.RegisterDefinition: Get the name of the register.
getName() - Method in class me.legrange.panstamp.definition.Unit: The name of the unit.
getName() - Method in interface me.legrange.panstamp.Endpoint: Return the name of this endpoint.
getName() - Method in class me.legrange.panstamp.PanStamp: Get the device name (as defined by the endpoint definition).
getName() - Method in interface me.legrange.panstamp.Parameter: Return the name of the parameter (as defined by XML)
getName() - Method in class me.legrange.panstamp.Register: Get the register name as defined in XML.
getNetwork() - Method in class me.legrange.panstamp.PanStamp: Return the network ID
getNetworkId() - Method in class me.legrange.panstamp.Network: return the network ID for the network supported by this network
getNetworkID() - Method in class me.legrange.swap.ModemSetup
getOffset() - Method in class me.legrange.panstamp.definition.Unit: The offset constant for the data.
getParameters() - Method in interface me.legrange.panstamp.definition.RegisterDefinition: Get the parameter definitions defined for this register definition.
getParameters() - Method in class me.legrange.panstamp.Register: Returns the parameters (if any) for this endpoint
getPattern() - Method in interface me.legrange.panstamp.Parameter: Return the verification pattern for this parameter.
getPort() - Method in class me.legrange.swap.SerialModem: Get the name of the serial port used by this modem.
getPort() - Method in class me.legrange.swap.tcp.TcpModem: Get the TCP port the modem is connected to.
getPosition() - Method in interface me.legrange.panstamp.definition.EndpointDefinition: Get the position of the endpoint data within the register.
getPosition() - Method in interface me.legrange.panstamp.definition.ParameterDefinition: Get the position of the parameter data within the register.
getProduct() - Method in interface me.legrange.panstamp.definition.DeviceDefinition: Get the product description of the device / product.
getProductId() - Method in class me.legrange.panstamp.PanStamp: Get the device product id.
getReceiver() - Method in class me.legrange.swap.SerialMessage
getReceiver() - Method in interface me.legrange.swap.SwapMessage
getReceiver() - Method in class me.legrange.swap.UserMessage
getRegister(int) - Method in interface me.legrange.panstamp.definition.DeviceDefinition: Return the register definition for the register with the given ID.
getRegister() - Method in interface me.legrange.panstamp.definition.EndpointDefinition: Get the register definition to which this endpoint definition applies.
getRegister() - Method in interface me.legrange.panstamp.Endpoint: Get the register to which this endpoint is associated.
getRegister(int) - Method in class me.legrange.panstamp.PanStamp: Get the register with the given register ID for this device.
getRegister() - Method in interface me.legrange.panstamp.Parameter: Returns the register associated with this parameter.
getRegisterAddress() - Method in class me.legrange.swap.SerialMessage
getRegisterAddress() - Method in interface me.legrange.swap.SwapMessage
getRegisterAddress() - Method in class me.legrange.swap.UserMessage
getRegisterID() - Method in class me.legrange.swap.SerialMessage
getRegisterID() - Method in interface me.legrange.swap.SwapMessage
getRegisterID() - Method in class me.legrange.swap.UserMessage
getRegisters() - Method in interface me.legrange.panstamp.definition.DeviceDefinition: Get the definitions for the registers defined in the device configuration.
getRegisters() - Method in class me.legrange.panstamp.PanStamp: Get the list of registers defined for this device
getRegisterValue(Register) - Method in class example.ConfigDeviceStateStore
getRegisterValue(Register) - Method in interface me.legrange.panstamp.DeviceStateStore: Return the stored register value for the given register.
getRegisterValue() - Method in class me.legrange.swap.SerialMessage
getRegisterValue() - Method in interface me.legrange.swap.SwapMessage
getRegisterValue() - Method in class me.legrange.swap.UserMessage
getRssi() - Method in class me.legrange.swap.SerialMessage
getRssi() - Method in interface me.legrange.swap.SwapMessage
getRssi() - Method in class me.legrange.swap.UserMessage
getSecurity() - Method in class me.legrange.swap.SerialMessage
getSecurity() - Method in interface me.legrange.swap.SwapMessage
getSecurity() - Method in class me.legrange.swap.UserMessage
getSecurityNonce() - Method in class me.legrange.swap.SerialMessage
getSecurityNonce() - Method in interface me.legrange.swap.SwapMessage
getSecurityNonce() - Method in class me.legrange.swap.UserMessage
getSecurityOption() - Method in class me.legrange.panstamp.Network: Get the security option
getSecurityOption() - Method in class me.legrange.panstamp.PanStamp: Return the current security option
getSender() - Method in class me.legrange.swap.SerialMessage
getSender() - Method in interface me.legrange.swap.SwapMessage
getSender() - Method in class me.legrange.swap.UserMessage
getSetup() - Method in class me.legrange.swap.SerialModem
getSetup() - Method in interface me.legrange.swap.SwapModem: get the network setup
getSetup() - Method in class me.legrange.swap.tcp.TcpModem
getSize() - Method in interface me.legrange.panstamp.definition.EndpointDefinition: Get the size of the endpoint data within the register.
getSize() - Method in interface me.legrange.panstamp.definition.ParameterDefinition: Get the size of the parameter data within the register.
getSWAPModem() - Method in class me.legrange.panstamp.Network: return the SWAP modem to gain access to the lower layer
getSyncState() - Method in class me.legrange.panstamp.PanStamp: Return the current sync state
getText() - Method in class me.legrange.swap.SerialMessage
getText() - Method in interface me.legrange.swap.SwapMessage
getText() - Method in class me.legrange.swap.UserMessage
getTxInterval() - Method in class me.legrange.panstamp.PanStamp: Return the transmit interval
getType() - Method in interface me.legrange.panstamp.definition.EndpointDefinition: Get the data type for this endpoint.
getType() - Method in interface me.legrange.panstamp.definition.ParameterDefinition: Get the data type of the parameter
getType() - Method in class me.legrange.panstamp.definition.Size: Get the type of this size (is it in bytes or bits).
getType() - Method in interface me.legrange.panstamp.Endpoint: Return the type of the data supported by this endpoint
getType() - Method in interface me.legrange.panstamp.Parameter: Return the type of the parameter.
getType() - Method in class me.legrange.swap.SerialMessage
getType() - Method in class me.legrange.swap.SerialModem
getType() - Method in interface me.legrange.swap.SwapMessage
getType() - Method in interface me.legrange.swap.SwapModem: determine the type of virtual modem
getType() - Method in class me.legrange.swap.tcp.TcpModem
getType() - Method in class me.legrange.swap.UserMessage
getUnit() - Method in interface me.legrange.panstamp.Endpoint: Return the unit currently used for converting the endpoint values.
getUnits() - Method in interface me.legrange.panstamp.definition.EndpointDefinition: Get the data units supported by the endpoint.
getUnits() - Method in interface me.legrange.panstamp.Endpoint: Get the units supported by this endpoint
getValue(String) - Method in interface me.legrange.panstamp.Endpoint: returns the current value of the endpoint in the given unit.
getValue() - Method in interface me.legrange.panstamp.Endpoint: returns the current value of the endpoint.
getValue() - Method in interface me.legrange.panstamp.Parameter
getValue() - Method in class me.legrange.panstamp.Register: get the value of the register
getVerif() - Method in interface me.legrange.panstamp.definition.ParameterDefinition: Get the verification patter for the parameter as per XML.

H

hasDevice(int) - Method in class me.legrange.panstamp.Network: use to check if a device with the given address is known
hasDeviceDefinition(int, int) - Method in class me.legrange.panstamp.definition.CompoundDeviceLibrary
hasDeviceDefinition(int, int) - Method in interface me.legrange.panstamp.DeviceLibrary: Checks if a device definition for the supplied manufacturer ID and product ID is available.
hasEndpoint(String) - Method in class me.legrange.panstamp.Register: returns true if the device has an endpoint with the given name
hasRegister(int) - Method in interface me.legrange.panstamp.definition.DeviceDefinition: Check if the device definition contains a register definition for the given register ID.
hasRegister(int) - Method in class me.legrange.panstamp.PanStamp: Determine if the device has a register with the given ID.
hasRegisterValue(Register) - Method in class example.ConfigDeviceStateStore
hasRegisterValue(Register) - Method in interface me.legrange.panstamp.DeviceStateStore: Check if a stored register value for the given register is available.
hasValue() - Method in interface me.legrange.panstamp.Endpoint: Checks if the endpoint has a value available.
hasValue() - Method in interface me.legrange.panstamp.Parameter: Returns true if the parameter has a known value
hasValue() - Method in class me.legrange.panstamp.Register: return true if the register has a currently known value
HttpLibrary - Class in me.legrange.panstamp.xml: An implementation of XMLDeviceLibrary that loads the XML definitions from a web server.
HttpLibrary(URL) - Constructor for class me.legrange.panstamp.xml.HttpLibrary

I

isExtended() - Method in class me.legrange.swap.SerialMessage
isExtended() - Method in interface me.legrange.swap.SwapMessage
isExtended() - Method in class me.legrange.swap.UserMessage
isOpen() - Method in class me.legrange.panstamp.Network: Check if the network is open (is connected to a panStamp network).
isOpen() - Method in class me.legrange.swap.SerialModem
isOpen() - Method in interface me.legrange.swap.SwapModem: Check if the modem is open (connected to it's implementation device)
isOpen() - Method in class me.legrange.swap.tcp.TcpModem
isOutput() - Method in interface me.legrange.panstamp.Endpoint: Test if the endpoint is an output or just an input.
isPowerDownMode() - Method in interface me.legrange.panstamp.definition.DeviceDefinition: Get the power down mode of this device.
isStandard() - Method in class me.legrange.panstamp.Register: return true if the register is one of the panStamp standard registers.
isStandardRegister() - Method in class me.legrange.swap.SerialMessage
isStandardRegister() - Method in interface me.legrange.swap.SwapMessage
isStandardRegister() - Method in class me.legrange.swap.UserMessage

L

ListDevices - Class in example
ListDevices() - Constructor for class example.ListDevices

M

main(String...) - Static method in class example.ListDevices
main(String...) - Static method in class example.OpenSerial
main(String...) - Static method in class example.ReadTemps
main(String...) - Static method in class example.TestCompoundLibrary
main(String...) - Static method in class example.TestEvents
main(String...) - Static method in class example.TestFileLibrary
main(String...) - Static method in class example.TestHttpLibrary
main(String...) - Static method in class example.TestTCPServer
MAX_STANDARD_REGISTER - Static variable in interface me.legrange.swap.SwapMessage: Maximum register ID for standard SWAP messages
me.legrange.panstamp - package me.legrange.panstamp: Provides the top level abstractions for working with a panStamp network.
me.legrange.panstamp.definition - package me.legrange.panstamp.definition: Device definition objects can be used to define device capabilities.
me.legrange.panstamp.event - package me.legrange.panstamp.event: This package contains convenience class implementations for the main interfaces from the me.legrange.panstamp package.
me.legrange.panstamp.xml - package me.legrange.panstamp.xml: The default XML implementation of the device definitions.
me.legrange.swap - package me.legrange.swap: An implementation of the SWAP protocol, including an interface to the serial SWAP modem.
me.legrange.swap.tcp - package me.legrange.swap.tcp: A client/server TCP implementation of SwapModem.
MessageListener - Interface in me.legrange.swap: Implement this to receive incoming SWAP messages.
messageReceived(SwapMessage) - Method in interface me.legrange.swap.MessageListener: receive message
messageSent(SwapMessage) - Method in interface me.legrange.swap.MessageListener: receive status message
ModemException - Exception in me.legrange.panstamp: Thrown when there is a problem with modem communication.
ModemSetup - Class in me.legrange.swap: A class that encapsulates the modem sketch's settings.
ModemSetup(int, int, int) - Constructor for class me.legrange.swap.ModemSetup

N

Network - Class in me.legrange.panstamp: A gateway connecting a panStamp network to your code using the SWAP modem supplied.
networkClosed(Network) - Method in class me.legrange.panstamp.event.AbstractNetworkListener
networkClosed(Network) - Method in interface me.legrange.panstamp.NetworkListener: The network was closed.
NetworkEvents - Class in example
NetworkEvents() - Constructor for class example.NetworkEvents
NetworkException - Exception in me.legrange.panstamp: Super class of exceptions thrown by the gateway
NetworkException(String) - Constructor for exception me.legrange.panstamp.NetworkException
NetworkException(String, Throwable) - Constructor for exception me.legrange.panstamp.NetworkException
NetworkListener - Interface in me.legrange.panstamp: A listener that can be implemented to receive events from the gateway.
networkOpened(Network) - Method in class me.legrange.panstamp.event.AbstractNetworkListener
networkOpened(Network) - Method in interface me.legrange.panstamp.NetworkListener: The network was opened.
NodeNotFoundException - Exception in me.legrange.panstamp: Thrown when a panStamp device cannot be found in the network.
NodeNotFoundException(String) - Constructor for exception me.legrange.panstamp.NodeNotFoundException
NodeNotFoundException(String, Throwable) - Constructor for exception me.legrange.panstamp.NodeNotFoundException
nw - Variable in class example.Example
nw - Variable in class example.ReadTemps

O

open() - Method in class me.legrange.panstamp.Network: Open the network.
open() - Method in class me.legrange.swap.SerialModem
open() - Method in interface me.legrange.swap.SwapModem: connect to the modem.
open() - Method in class me.legrange.swap.tcp.TcpModem
OpenSerial - Class in example: Simple example: Open a gateway for a serial connected network.
OpenSerial() - Constructor for class example.OpenSerial
openSerial(String, int) - Static method in class me.legrange.panstamp.Network: 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.
openTcp(String, int) - Static method in class me.legrange.panstamp.Network: 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.

P

PanStamp - Class in me.legrange.panstamp: An implementation of a panStamp abstraction.
PanStamp(Network, int) - Constructor for class me.legrange.panstamp.PanStamp: create a new mote for the given address in the given network
PanStampListener - Interface in me.legrange.panstamp: A listener that can be implemented to receive events from a panStamp device.
Parameter<T> - Interface in me.legrange.panstamp: A parameter that can be set for a panStamp device.
Parameter.Type - Enum in me.legrange.panstamp: Type of value sent and/or received by an endpoint.
parameterAdded(Register, Parameter) - Method in class me.legrange.panstamp.event.AbstractRegisterListener
parameterAdded(Register, Parameter) - Method in interface me.legrange.panstamp.RegisterListener: A parameter was added to a register.
ParameterDefinition - Interface in me.legrange.panstamp.definition: A device parameter definition.
PORT - Static variable in class example.TestTCPServer
Position - Class in me.legrange.panstamp.definition: The position of data relative to a panStamp register definition.
Position(int, int) - Constructor for class me.legrange.panstamp.definition.Position
Position(int) - Constructor for class me.legrange.panstamp.definition.Position
productCodeChange(PanStamp, int, int) - Method in class me.legrange.panstamp.event.AbstractPanStampListener
productCodeChange(PanStamp, int, int) - Method in interface me.legrange.panstamp.PanStampListener: The product code for a panStamp was changed.

R

ReadAndSetNetworkInformation - Class in example
ReadAndSetNetworkInformation() - Constructor for class example.ReadAndSetNetworkInformation
ReadAndSetPanStampInformation - Class in example
ReadAndSetPanStampInformation() - Constructor for class example.ReadAndSetPanStampInformation
ReadTemps - Class in example
ReadTemps() - Constructor for class example.ReadTemps
Register - Class in me.legrange.panstamp: An abstraction of a panStamp register.
RegisterDefinition - Interface in me.legrange.panstamp.definition: A device register definition.
registerDetected(PanStamp, Register) - Method in class me.legrange.panstamp.event.AbstractPanStampListener
registerDetected(PanStamp, Register) - Method in interface me.legrange.panstamp.PanStampListener: A new register was added to a panStamp device.
RegisterListener - Interface in me.legrange.panstamp: Implement this to receive updates when registers change.
removeDevice(int) - Method in class me.legrange.panstamp.Network: Removes the device with the given address from the network
removeListener(EndpointListener<T>) - Method in interface me.legrange.panstamp.Endpoint: Remove a listener from the endpoint.
removeListener(NetworkListener) - Method in class me.legrange.panstamp.Network: remove a listener from the network
removeListener(PanStampListener) - Method in class me.legrange.panstamp.PanStamp: remove an event listener
removeListener(RegisterListener) - Method in class me.legrange.panstamp.Register: remove a listener
removeListener(MessageListener) - Method in class me.legrange.swap.SerialModem
removeListener(MessageListener) - Method in interface me.legrange.swap.SwapModem: remove a listener
removeListener(MessageListener) - Method in class me.legrange.swap.tcp.TcpModem
run() - Method in class example.Example
run() - Method in class example.ReadTemps

S

send(SwapMessage) - Method in class me.legrange.swap.SerialModem
send(SwapMessage) - Method in interface me.legrange.swap.SwapModem: send a message out onto the network
send(SwapMessage) - Method in class me.legrange.swap.tcp.TcpModem
SerialException - Exception in me.legrange.swap: Thrown when there is a Serial IO error
SerialMessage - Class in me.legrange.swap: A SWAP message received from the serial modem.
SerialMessage(String) - Constructor for class me.legrange.swap.SerialMessage
SerialModem - Class in me.legrange.swap: An interface providing access through the serial port to the SWAP modem.
SerialModem(String, int) - Constructor for class me.legrange.swap.SerialModem
setAddress(int) - Method in class me.legrange.panstamp.PanStamp: Set the address of the panStamp
setChannel(int) - Method in class me.legrange.panstamp.Network: Set the frequency channel
setChannel(int) - Method in class me.legrange.panstamp.PanStamp: Set the network channel of the device
setChannel(int) - Method in class me.legrange.swap.ModemSetup
setDeviceAddress(int) - Method in class me.legrange.panstamp.Network: Set the device address for the network panStamp
setDeviceAddress(int) - Method in class me.legrange.swap.ModemSetup
setDeviceLibrary(DeviceLibrary) - Method in class me.legrange.panstamp.Network: Set the device library used to lookup device definitions.
setDeviceStore(DeviceStateStore) - Method in class me.legrange.panstamp.Network: Set the device store to use to lookup persisted device registers.
setNetwork(int) - Method in class me.legrange.panstamp.PanStamp: Set the network id of the device
setNetworkId(int) - Method in class me.legrange.panstamp.Network: Set the network ID for the network accessed by this network
setNetworkID(int) - Method in class me.legrange.swap.ModemSetup
setRegisterAddress(int) - Method in class me.legrange.swap.UserMessage
setRegisterValue(Register, byte[]) - Method in class example.ConfigDeviceStateStore
setRegisterValue(Register, byte[]) - Method in interface me.legrange.panstamp.DeviceStateStore: Store the register value for the register.
setSecurity(int) - Method in class me.legrange.swap.UserMessage
setSecurityNonce(int) - Method in class me.legrange.swap.UserMessage
setSecurityOption(int) - Method in class me.legrange.panstamp.Network: Set the security option
setSecurityOption(int) - Method in class me.legrange.panstamp.PanStamp: Set the security option of the device.
setSetup(ModemSetup) - Method in class me.legrange.swap.SerialModem
setSetup(ModemSetup) - Method in interface me.legrange.swap.SwapModem: set the network setup
setSetup(ModemSetup) - Method in class me.legrange.swap.tcp.TcpModem
setTxInterval(int) - Method in class me.legrange.panstamp.PanStamp: Set the transmit interval (in seconds) of the device.
setUnit(String) - Method in interface me.legrange.panstamp.Endpoint: Set the unit to use for converting endpoint values.
setValue(String, T) - Method in interface me.legrange.panstamp.Endpoint: set the value of the endpoint
setValue(T) - Method in interface me.legrange.panstamp.Endpoint: set the value of the endpoint
setValue(T) - Method in interface me.legrange.panstamp.Parameter: set the value of the parameter
setValue(byte[]) - Method in class me.legrange.panstamp.Register: set the register value and send to remote node
Size - Class in me.legrange.panstamp.definition: The size of a data point (endpoint or parameter).
Size(int) - Constructor for class me.legrange.panstamp.definition.Size
Size(int, int) - Constructor for class me.legrange.panstamp.definition.Size
Size.Type - Enum in me.legrange.panstamp.definition
SwapException - Exception in me.legrange.swap: Super class of exceptions thrown by the gateway
SwapException(String) - Constructor for exception me.legrange.swap.SwapException
SwapException(String, Throwable) - Constructor for exception me.legrange.swap.SwapException
SwapMessage - Interface in me.legrange.swap: A SWAP message sent or received via the SWAP modem application.
SwapMessage.Type - Enum in me.legrange.swap: Types of SWAP messages
SwapModem - Interface in me.legrange.swap: A virtual modem that provides access to a SWAP transport.
SwapModem.Type - Enum in me.legrange.swap: Type of SWAP modem.
syncRequired(PanStamp) - Method in class me.legrange.panstamp.event.AbstractPanStampListener
syncRequired(PanStamp) - Method in interface me.legrange.panstamp.PanStampListener: A panStamp device needs to go into one of the synchronization states that allows it to receive updates.
syncStateChange(PanStamp, int) - Method in class me.legrange.panstamp.event.AbstractPanStampListener
syncStateChange(PanStamp, int) - Method in interface me.legrange.panstamp.PanStampListener: The synchronization state of the device has changed.

T

TcpException - Exception in me.legrange.swap.tcp: Thrown by the TcpModem if there is a problem.
TcpModem - Class in me.legrange.swap.tcp: A SWAP modem implementation that works over TCP.
TcpModem(String, int) - Constructor for class me.legrange.swap.tcp.TcpModem
TcpServer - Class in me.legrange.swap.tcp: A TCP server that serves SWAP comms from a modem over TCP/IP
TcpServer(SwapModem, int) - Constructor for class me.legrange.swap.tcp.TcpServer
TestCompoundLibrary - Class in example
TestCompoundLibrary() - Constructor for class example.TestCompoundLibrary
TestEvents - Class in example: This example shows how to work with the classes from Network, PanStamp, Register and Endpoint so that events for all instances in the structure can be received.
TestEvents() - Constructor for class example.TestEvents
TestFileLibrary - Class in example
TestFileLibrary() - Constructor for class example.TestFileLibrary
TestHttpLibrary - Class in example
TestHttpLibrary() - Constructor for class example.TestHttpLibrary
TestTCPServer - Class in example
TestTCPServer() - Constructor for class example.TestTCPServer
toString() - Method in class me.legrange.swap.ModemSetup
toString() - Method in class me.legrange.swap.SerialMessage
toString() - Method in class me.legrange.swap.UserMessage
Type - Enum in me.legrange.panstamp.definition: The data types defined for endpoint and parameter data.

U

Unit - Class in me.legrange.panstamp.definition: A unit definition for endpoint data.
Unit(String, double, double) - Constructor for class me.legrange.panstamp.definition.Unit
UserMessage - Class in me.legrange.swap: An implementation of SwapMessage for messages originating from the application.
UserMessage(boolean, SwapMessage.Type, int, int, int, byte[]) - Constructor for class me.legrange.swap.UserMessage

V

valueOf(String) - Static method in enum me.legrange.panstamp.definition.Direction: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum me.legrange.panstamp.definition.Size.Type: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum me.legrange.panstamp.definition.Type: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum me.legrange.panstamp.Endpoint.Type: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum me.legrange.panstamp.Parameter.Type: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum me.legrange.swap.SwapMessage.Type: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum me.legrange.swap.SwapModem.Type: Returns the enum constant of this type with the specified name.
valueReceived(Endpoint<T>, T) - Method in interface me.legrange.panstamp.EndpointListener: Called on listeners if a new value was received for the endpoint
valueReceived(Endpoint<T>, T) - Method in class me.legrange.panstamp.event.AbstractEndpointListener
valueReceived(Register, byte[]) - Method in class me.legrange.panstamp.event.AbstractRegisterListener
valueReceived(Register, byte[]) - Method in interface me.legrange.panstamp.RegisterListener: A value for the register was received from the network.
values() - Static method in enum me.legrange.panstamp.definition.Direction: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum me.legrange.panstamp.definition.Size.Type: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum me.legrange.panstamp.definition.Type: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum me.legrange.panstamp.Endpoint.Type: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum me.legrange.panstamp.Parameter.Type: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum me.legrange.swap.SwapMessage.Type: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum me.legrange.swap.SwapModem.Type: Returns an array containing the constants of this enum type, in the order they are declared.
valueSet(Register, byte[]) - Method in class me.legrange.panstamp.event.AbstractRegisterListener
valueSet(Register, byte[]) - Method in interface me.legrange.panstamp.RegisterListener: A value for the register was set by the application.

A C D E F G H I L M N O P R S T U V