Name 

Description 

 

OnGatewayMessage 

Public EventGatewayMessage; *

• 
  
• Fired when a message is received from a gateway.

*

• @param gatewayMessage Class holding data about the gateway communication.
• @throws java.lang.InterruptedException

 

 

OnLogException 

• 
  
• Fired when an exception is caught allowing the exception to be logged.

public EventLogException; *

• 
  
• Fires the LogException event.

*

• @param ex Exception to be passed.
• @param location Method name where the exception occurred.

 

 

OnPersistGateway 

• 
  
• Fired when changes have been made to the gateway object that can be
• persisted to a permanent data store.

public EventPersistGateway; *

• 
  
• Fires PersistGateway event.

*

• @param gatewayID Numerical identifier of gateway.

 

 

OnPersistSensor 

• 
  
• Fired when changes have been made to the sensor object that can be
• persisted to a permanent data store.

public EventPersistSensor; *

• 
  
• Fires PersitSensor event.

*

• @param sensor Sensor that has been modified.

 

 

OnSensorMessages 

public EventSensorMessage; *

• 
  
• Fired when one or more sensor messages are received.

*

• @param sensorMessages List of sensor data messages.
• @param gatewayID Numerical identifier of gateway that send the messages.

 

 

OnUnknownGateway 

public event EventHandlerUnknownGateway; *

• 
  
• Fired when Mine receives a message from an unregistered gateway.

*

• @param gatewayID numeric identifier of the gateway
• @param gatewayType is type associated with the gateway

 

 

OnUnknownSensor 

public event EventHandlerUnknownSensor; *

• 
  
• Fired when a gateway declines a join from a sensor.

*

• @param sensorID numeric identifier of the sensor
• @param sensorApplication is type associated with the sensor

 

 

Name 

Description 

 

GatewayResponseHandlers 

GATEWAY RESPONSE HANDLING 

 

Name 

Description 

 

> 

Properties 

 

>> 

This is >>, a member of class MineServer. 

 

addExceptionProcessingHandler 

This is addExceptionProcessingHandler, a member of class MineServer. 

 

addGatewayDataProcessingHandler 

This is addGatewayDataProcessingHandler, a member of class MineServer. 

 

addGatewayResponseHandler 

This is addGatewayResponseHandler, a member of class MineServer. 

 

addPersistGatewayHandler 

This is addPersistGatewayHandler, a member of class MineServer. 

 

addPersistSensorHandler 

This is addPersistSensorHandler, a member of class MineServer. 

 

addSensorDataProcessingHandler 

This is addSensorDataProcessingHandler, a member of class MineServer. 

 

addUnknownGatewayHandler 

This is addUnknownGatewayHandler, a member of class MineServer. 

 

addUnknownSensorHandler 

This is addUnknownSensorHandler, a member of class MineServer. 

 

assignExternalDeviceStorageHandler 

This is assignExternalDeviceStorageHandler, a member of class MineServer. 

 

ClearCommandQueue 

Clear queue of all commands to be sent to sensor @param sensorID Numerical identifier of sensor to send command @throws Exception if sensor is not found 

 

CurrentUTC 

Returns a UTC Calendar based on the seconds passed in @param seconds the seconds since January 1st 2010 

 

DisplayDateAsUTC 

Returns a simpleDateFormat of ("E MMM dd yyyy hh:mm:ss a")date and time will look like -> Fri Jan 01 2010 12:00:00 PM. for display purposes @param calendar Calendar object used for date and time information 

 

EnqueueCommand 

Queues sensor specific command to be sent down @param sensorID Numerical identifier of sensor to send command @param commandFrame Frame for command as returned by SensorBaseProfile class @param isUrgent Will set the urgent flag so that the command is broadcast when received by the gateway @throws Exception if sensor is not found 

 

FindGateway 

Access to the object instances used by the server. Returns null if gatewayID does not belong to any of the registered gateways. @param gatewayID Numeric identifier of the gateway object. @return The gateway object stored in memory 

 

FindGatewayByExternalIdentifier 

class MineServerInternal { Internal Methods 

 

FindGatewayBySensorID 

Access to the object instances used by the server. Returns null if sensorID does not belong to any of the registered gateways. @param sensorID Numeric identifier of the gateway object's sensorID. @return The gateway object stored in memory 

 

FindGatewaysForSensor 

Access to the object instances used by the server. Returns empty if gatewayID is not found. @param sensorID is the sensor assigned ID @throws InterruptedException if gateway is invalid @return The list of sensor objects assigned to the gateway 

 

FindSensor 

Access to the object instances used by the server. Returns null if sensorID does not belong to any of the registered gateways. @param sensorID Numeric identifier of the sensor object. @return The sensor object stored in memory @throws InterruptedException if gateway is invalid 

 

FindSensorsByGateway 

Access to the object instances used by the server. @param gatewayID Numeric identifier of the gateway object. @return The list of sensor objects assigned to the gateway @throws InterruptedException if gateway is invalid 

 

GetCalendarFromSeconds 

Returns a UTC Calendar based on the seconds passed in @param seconds the seconds since January 1st 2010 

 

GetStartUPParameters 

This is GetStartUPParameters, a member of class MineServer. 

 

getVersion 

Returns the current version of the API  

 

HandleActionControlAck 

This is HandleActionControlAck, a member of class MineServer. 

 

HandleFindGateway 

This is HandleFindGateway, a member of class MineServer. 

 

HandleParentMessage 

This is HandleParentMessage, a member of class MineServer. 

 

HandleReadDataAck 

This is HandleReadDataAck, a member of class MineServer. 

 

HandleWriteDataAck 

This is HandleWriteDataAck, a member of class MineServer. 

 

MineServer 

This is the overview for the MineServer constructor overload. 

 

OnACTLAck 

This is OnACTLAck, a member of class MineServer. 

 

OnBootloaderAck 

This is OnBootloaderAck, a member of class MineServer. 

 

OnFindGateway 

This is OnFindGateway, a member of class MineServer. 

 

OnNetworkStatus 

This is OnNetworkStatus, a member of class MineServer. 

 

OnParentMsg 

This is OnParentMsg, a member of class MineServer. 

 

OnProcessData 

This is OnProcessData, a member of class MineServer. 

 

OnReadDataAck 

This is OnReadDataAck, a member of class MineServer. 

 

OnSensorStatus 

This is OnSensorStatus, a member of class MineServer. 

 

OnWriteDataAck 

This is OnWriteDataAck, a member of class MineServer. 

 

ParseIP 

This is ParseIP, a member of class MineServer. 

 

ParseMessage 

This is ParseMessage, a member of class MineServer. 

 

ProcessBytes 

This is ProcessBytes, a member of class MineServer. 

 

RegisterGateway 

Adds the gateway to the servers list of valid objects @param gateway Gateway object @throws Exception There is already a gateway registered with the same gatewayID, or gatewayID property of gateway is not valid (Zero is not a valid gatewayID) 

 

RegisterSensor 

Adds the sensor to the servers list of valid objects @param gatewayID is the ID number assigned to the gateway @param sensor Sensor object ArgumentNullException Parameter "sensor" is null @throws java.lang.Exception There is already a sensor registered with the same sensorID, or sensorID property of sensor is not valid (Zero is not a valid sensorID) 

 

removeExceptionProcessingHandler 

This is removeExceptionProcessingHandler, a member of class MineServer. 

 

removeExternalDeviceStorageHandler 

This is removeExternalDeviceStorageHandler, a member of class MineServer. 

 

RemoveGateway 

Removes the gateway from the servers list of valid objects @param gatewayID Numeric identifier of the gateway object. 

 

removeGatewayDataProcessingHandler 

This is removeGatewayDataProcessingHandler, a member of class MineServer. 

 

removeGatewayResponseHandler 

This is removeGatewayResponseHandler, a member of class MineServer. 

 

removePersistGatewayHandler 

This is removePersistGatewayHandler, a member of class MineServer. 

 

removePersistSensorHandler 

This is removePersistSensorHandler, a member of class MineServer. 

 

RemoveSensor 

Removes the sensor from the servers list of valid objects @param sensorID Numeric identifier of the sensor object. @throws InterruptedException if sensor is unregistered 

 

removeSensorDataProcessingHandler 

This is removeSensorDataProcessingHandler, a member of class MineServer. 

 

removeUnknownGatewayHandler 

This is removeUnknownGatewayHandler, a member of class MineServer. 

 

removeUnknownSensorHandler 

This is removeUnknownSensorHandler, a member of class MineServer. 

 

resetEncryptionAck 

This is the overview for the resetEncryptionAck method overload. 

 

SecondsSinceFirstDate 

gets how many seconds its been since January 1st 2010 to set date timesreturns the time based off of UTC / 

 

ShowDebugMessages 

Public Methods 

 

StartServer 

This call starts the socket listeners that the gateways will use to communicate @throws Exception if IP/Port is already bound to another socket. 

 

StopServer 

This call stops the socket listeners that the gateways will use to communicate @throws InterruptedException TCP socket is used @throws IOException UDP socket is used 

 

UpdateTimeZoneToUTC 

Returns a UTC Calendar object @param calendar Calendar object used for date and time information