Name 

Description 

 

OnGatewayMessage 

Public Event GatewayMessage;

Fired when a message is received from a gateway.
 

 

OnLogException 

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

public Event LogException; *

• 
  
• 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 Event PersistGateway; *

• 
  
• 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 Event PersistSensor; *

• 
  
• Fires PersitSensor event.

*

• @param sensorID Numerical identifier of sensor.

 

 

OnSensorMessages 

public Event SensorMessage;

Fired when one or more sensor messages are received.
 

 

OnUnknownGateway 

public event EventHandler UnknownGateway;

Fired when Mine receives a message from an unregistered gateway.
 

 

OnUnknownSensor 

public event EventHandler UnknownSensor;

Fired when a gateway declines a join from a sensor.
 

 

Name 

Description 

 

GatewayResponseHandlers 

GATEWAY RESPONSE HANDLING 

 

Name 

Description 

 

MineServer 

#region Constructors
Initializes a new instance of the Server class.
 

 

Name 

Description 

 

> 

Properties 

 

ClearCommandQueue 

Clear queue of all commands to be sent to sensor
 

 

CurrentUTC 

Returns a UTC Calendar based on the seconds passed in
 

 

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
 

 

EnqueueCommand 

Queues sensor specific command to be sent down
 

 

FindGateway 

Access to the object instances used by the server. Returns null if gatewayID does not belong to any of the registered gateways.
 

 

FindGatewayByExternalIdentifier 

class MineServerInternal { Internal Methods 

 

FindGatewaysForSensor 

Access to the object instances used by the server. Returns empty if gatewayID is not found.
 

 

FindSensor 

Access to the object instances used by the server. Returns null if sensorID does not belong to any of the registered gateways.
 

 

FindSensorsForGateway 

Access to the object instances used by the server. Returns empty if gatewayID is not found.
 

 

GetCalendarFromSeconds 

Returns a UTC Calendar based on the seconds passed in
 

 

getVersion 

Returns the current version of the API  

 

RegisterGateway 

Adds the gateway to the servers list of valid objects
 

 

RegisterSensor 

Adds the sensor to the servers list of valid objects
 

 

RemoveGateway 

Removes the gateway from the servers list of valid objects
 

 

RemoveSensor 

Removes the sensor from the servers list of valid objects
 

 

resetEncryptionAck 

Gateway Commands 

 

SecondsSinceFirstDate 

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

 

StartServer 

Public Methods

This call starts the socket listeners that the gateways will use to communicate
 

 

StopServer 

This call stops the socket listeners that the gateways will use to communicate
 

 

UpdateTimeZoneToUTC 

Returns a UTC Calendar object