Name 

Description 

 

ActionControlCommandIsUrgent 

The action control command that will be sent to the sensor is urgent  

 

ActionControlCommands 

The action control command(s) that will be sent to the sensor  

 

ActiveStateInterval 

Defines in minutes the interval at which the sensor communicates with the gateway when the sensor is in the aware state. Unless triggered to communicate earlier, the sensor will send a data message to the gateway when this many minutes elapse.  

 

BiStable 

For trigger based sensors (Open/Closed, Water, etc) Determines if the sensor is bistable (triggers both directions) or monostable (triggers one direction)  

 

Calibration1 

For interval based sensors (Temperature, Humidity, etc) Value used by profiles for calibration  

 

Calibration2 

For interval based sensors (Temperature, Humidity, etc) Value used by profiles for calibration  

 

Calibration3 

For interval based sensors (Temperature, Humidity, etc) Value used by profiles for calibration  

 

Calibration4 

For interval based sensors (Temperature, Humidity, etc) Value used by profiles for calibration  

 

DataLog 

For Wi-Fi sensors Determines whether to use short term logging or long term data logging on the sensor when Wi-Fi connection is not available  

 

EventDetectionCount 

For trigger based sensors (Open/Closed, Water, etc) Sets the event count that must be breached to trigger the event  

 

EventDetectionPeriod 

For trigger based sensors (Open/Closed, Water, etc) Sets the time period in ms that the event detection count to increment before it is reset  

 

EventDetectionType 

For trigger based sensors (Open/Closed, Water, etc) Determines if the sensor is normally open or normally closed, the other state triggering aware  

 

FirmwareVersion 

The firmware of the sensor  

 

GeneralConfig1Dirty 

set when the ReportInterval, ActiveStateInterval or TransmitIntervalLink  

 

GeneralConfig2Dirty 

set when Recovery is changed  

 

GenerationType 

The value of which generation type the sensor belongs to. IE (Gen1, Gen2)  

 

Hysteresis 

For interval based sensors (Temperature, Humidity, etc) When leaving aware mode back into standard mode the sensor reading must clear the Max or Min threshold by this amount.  

 

MaximumThreshold 

For interval based sensors (Temperature, Humidity, etc) If reading is above this value the sensor enters aware mode  

 

MeasurementsPerTransmission 

For interval based sensors (Temperature, Humidity, etc) Sets often between report intervals the sensors samples against thresholds  

 

MinimumThreshold 

For interval based sensors (Temperature, Humidity, etc) If reading is below this value the sensor enters aware mode  

 

MonnitApplication 

the type of sensor being used such as temperature or humidity  

 

PendingActionControlCommand 

If set this flag will cause the action control command will be sent to the sensor  

 

ProfileConfig1Dirty 

If set this flag will cause the Profile Config 1 page to be sent to the sensor Affected Fields (Interval): MeasurementsPerTransmission, MaximumThreshold, MinimumThreshold, Hysteresis Affected Fields (Trigger): EventDetectionCount, EventDetectionPeriod, EventDetectionType, BiStable, RearmTime  

 

ProfileConfig2Dirty 

If set this flag will cause the Profile Config 2 page to be sent to the sensor Affected Fields (Interval): Calibration1, Calibration2, Calibration3, Calibration4  

 

RearmTime 

For trigger based sensors (Open/Closed, Water, etc) sets the amount of time before a bistable trigger is reset to observe another event  

 

Recovery 

Once the recovery count is reached, the sensor will go to link mode and begin scanning channels and trying to find a gateway to join  

 

ReportInterval 

how often the sensor will send non aware data to a gateway  

 

RetryCount 

How many times recovery should happen  

 

SensorID 

the unique sensor identifier  

 

TransmitIntervalLink 

How often the sensor attempts to re-link with a gateway once it goes into link mode. Values below 12 are interpreted as hours. values above 12 are interpreted as minutes. the max value allowed in this field is 250. if a value of 0 is given the sensor will default to a re-link interval of 2 hours  

 

Name 

Description 

 

BatteryPercentageHelper 

This is the overview for the BatteryPercentageHelper method overload. 

 

ForceConfiguration 

Force server held configurations to be sent to the sensor at the next communication cycle. @param section Configuration section to be sent to the server 

 

getActionControlCommandIsUrgent 

gets if acc has been set for the sensor  

 

getActionControlCommands 

this is now handled by the sensors base application class  

 

getActiveStateInterval 

gets the aware state heartbeat for the sensor  

 

getBiStable 

gets what the bistable value has been set as  

 

getCalibration1 

gets calibration 1 value  

 

getCalibration2 

gets calibration 2 value  

 

getCalibration3 

gets calibration 3 value  

 

getCalibration4 

gets calibration 4 value  

 

getDataLog 

This is getDataLog, a member of class Sensor. 

 

getEventDetectionCount 

gets the event detection count  

 

getEventDetectionPeriod 

gets event detection period  

 

getEventDetectionType 

gets the type of event that will put the trigger sensor in aware  

 

getFirmwareVersion 

gets the firmware version for the sensor  

 

getGeneralConfig1Dirty 

gets if update should take place  

 

getGeneralConfig2Dirty 

gets if general config 2 values should be updated or not.  

 

getGenerationType 

gets the Generation Type of the sensor @return String 

 

getHysteresis 

gets the hysteresis value  

 

getMaximumThreshold 

gets the maximum aware threshold  

 

getMeasurementsPerTransmission 

gets how many times during a report interval the sensor will take a measurement  

 

getMinimumThreshold 

gets the minimum aware threshold  

 

getMonnitApplication 

gets the application profile type of the sensor  

 

getPendingActionControlCommand 

gets if pending action control command has been set  

 

getProfileConfig1Dirty 

gets if there needs to be an update  

 

getProfileConfig2Dirty 

lets you know if calibration 1 through 4 has been changed  

 

getRearmTime 

get how long in seconds it take to allow a trigger type sensor to be able to be re-triggered  

 

getRecovery 

gets the value that should be reached before link mode  

 

getReportInterval 

gets the normal heartbeat for the sensor  

 

getRetryCount 

gets how many times the sensor will attempt to reconnect to the gateway  

 

getSensorID 

gets the sensors unique identifier  

 

getSensorPrint 

This is getSensorPrint, a member of class Sensor. 

 

getTransmitIntervalLink 

gets How often the sensor attempts to re-link with a gateway once it goes into link mode. Values below 12 are interpreted as hours. values above 12 are interpreted as minutes. the max value allowed in this field is 250. if a value of 0 is given the sensor will default to a re-link interval of 2 hours  

 

ReadConfigCommand 

Builds the command used to ask the sensor to send a copy of it's configuration page @param section The page of the sensor configuration to have the sensor send 

 

Sensor 

This is the overview for the Sensor constructor overload. 

 

setActionControlCommandIsUrgent 

sets the action control command @param actionControlCommandIsUrgent allows a u to set true or false if the update is an action command 

 

setActiveStateInterval 

sets the aware state heartbeat for the sensor @param activeStateInterval value represents minutes 

 

setBiStable 

If Aware Reading is selected, then the time between the message detecting motion and the message saying 'no motion' is (rearm time + aware state heartbeat).If set to All State Changes, then the time between the two messages is (rearm time + rearm time).This example assumes standard Aware on Motion state. @param bistable 0 or 1 value 

 

setCalibration1 

sets calibration 1 @param calibration1 different meanings dependent on the sensor 

 

setCalibration2 

sets calibration 2 @param calibration2 different meanings dependent on the sensor 

 

setCalibration3 

sets calibration 3 @param calibration3 different meanings dependent on the sensor 

 

setCalibration4 

sets calibration 4 @param calibration4 different meanings dependent on the sensor 

 

setDataLog 

This is setDataLog, a member of class Sensor. 

 

setEventDetectionCount 

determine by sensor type @param eventDetectionCount value dependent on sensor type 

 

setEventDetectionPeriod 

determined by sensor type @param eventDetectionPeriod value dependent on sensor type 

 

setEventDetectionType 

sets which reading of the sensor will trigger the aware state for trigger sensors @param eventDetectionType (starts = 0, stops = 1, state change = 2) 

 

setFirmwareVersion 

This is setFirmwareVersion, a member of class Sensor. 

 

setGeneralConfig1Dirty 

sets if general config 1 values should be updated @param generalConfig1Dirty allows update to take place 

 

setGeneralConfig2Dirty 

sets if GeneralConfig2Dirty values should be updated @param generalConfig2Dirty if set to true will update general config 2 values 

 

setGenerationType 

Sets the Generation Type of the sensor @param generation (Gen1, Gen2) 

 

setHysteresis 

A buffer to prevent the sensor from bouncing between standard operation and aware state when the assessments are very close to a threshold. for example, if a maximum threshold is set to 90 degrees and a hysteresis of 1 degree, then once the sensor takes an assessment of 90.0 degrees and enters the aware state it will remain in the aware state until the temperature readings drop to 89.0 degrees @param hysteresis value determined by sensor type 

 

setMaximumThreshold 

sets the maximum threshold of the aware state @param maximumThreshold value determined by sensor type 

 

setMeasurementsPerTransmission 

sets how many times during the heartbeat a measurement should be taken an example would be if you have a 10 minute reportinterval and you set this value to 2 every 5 minutes a measurement will be taken and if it is in the aware state it will send the data out otherwise it will wait until the report interval to be met to send the data to the gateway. @param measurementsPerTransmission how many times during a heartbeat sensor should take a measurement 

 

setMinimumThreshold 

sets the minimum threshold of the aware state @param minimumThreshold value determined by sensor type 

 

setMonnitApplication 

This is setMonnitApplication, a member of class Sensor. 

 

setPendingActionControlCommand 

allows you to set pending action control command @param isPending allows you update or not update 

 

setProfileConfig1Dirty 

allows you to set this value to true if specific values you need to updated  

 

setProfileConfig2Dirty 

set to true if any calibration 1 through 4 has been changed @param profileConfig2Dirty flag to find out if a specific update should take place 

 

setRearmTime 

set how long in seconds it take to allow a trigger type sensor to be able to be re-triggered  

 

setRecovery 

Once the recovery count is reached, the sensor will go to link mode and begin scanning channels and trying to find a gateway to join @param recovery value is the count that should be reached 

 

setReportInterval 

This is setReportInterval, a member of class Sensor. 

 

setRetryCount 

sets the retry count on the sensor @param retryCount how many times sensor should try to reconnect to the gateway 

 

setSensorID 

This is setSensorID, a member of class Sensor. 

 

setSensorPrint 

This is setSensorPrint, a member of class Sensor. 

 

setTransmitIntervalLink 

This is setTransmitIntervalLink, a member of class Sensor. 

 

UpdateLinkInterval 

Defines in minutes the interval at which the sensor attempts to link/re-link with the gateway. Link heartbeats greater than 1 hour will be rounded to the nearest hour. Accepted values between 1 and 720 (1 minute to 12 hours)  

 

UpdateRecoveryCount 

Sets number of messages sensor sends without acknowledgment from gateway before entering link mode Accepted values between 0 and 10 0 means unlimited (no self healing, power cycling senor will be required if gateway changes channel)  

 

UpdateReportInterval 

Defines in minutes the interval at which the sensor communicates with the gateway. Unless triggered to communicate earlier, the sensor will send a data message to the gateway when this many minutes elapse. Accepted values between .017 and 720 (1 second to 12 hours)  

 

UpdateRetryCount 

Sets number of RF packets sensor attempts to send a single message to gateway. Accepted values between 0 and 10