Java Mine
ContentsIndexHome
PreviousUpNext
Gateway Methods

The methods of the Gateway class are listed here.

 
Name 
Description 
 
@param comm The action control command that will be added to the ActionControlCommand List 
 
@param sensorID adds a sensorid to the AssignedSensors List 
 
This is the overview for the BatteryPercentageHelper method overload. 
 

Force server held configurations to be sent to the gateway at the next communication cycle.  
 
@return ActionControlCommands The action control command(s) that will be sent to the sensor 
 
@return AssignedSensors List of sensor ids that have been assigned to this gateway 
 
This is getAutoConfigCommand, a member of class Gateway. 
 
This is getAutoConfigTime, a member of class Gateway. 
 
@return DecryptFailureDate Hold time of previous decryption failure, ensures gateway can't continually send packets with wrong encryption scheme. Only allows one reset per hour. Default: null 
 
@return DefaultRouterIP If static IP is set: This is the value of the router address the gateway will send its data through to access the Internet. 
 
@return EncryptionIV Holds Initialization Vector generated in handshake. Rotates with each gateway startup Default: null 
 
@return EncryptionKey Holds encryption key generated in handshake. Rotates with each gateway startup Default: null 
 
@return ExternalIdentifier Differs by gateway type. One example is the Ethernet gateway stores it's MAC Address here 
 
@return GatewayDNS If static IP is set: This is the value of the primary DNS server used to resolve the host address of the server. If server is defined with IP Address this value is not used. 
 
@return GatewayFirmwareVersion Tracks the version of gateway firmware. Some features are only available on certain gateway versions. 
 

returns this unique Identifier @return GatewayID the numeric Identifier of the gateway.. 
 
@return GatewayIP IP address of the gateway if applicable. Default: 0.0.0.0 will inform the gateway to use DHCP to obtain an IP Address. 
 
@return GatewaySubnet If static IP is set: This is the value of the subnet mask of the network the gateway is operating on. 
 
@return GatewayType Type of the gateway. Certain settings are interpreted differently for different types of gateways 
 
This is getGPSReportInterval, a member of class Gateway. 
 
@return HasUrgentTraffic Flag that indicates if the server has urgent messages to deliver to the gateway. Responds to PollInterval for use in conjunction with Control Profile 
 
@return IsDirty Record of the last message sequence received from the gateway. Used to prevent duplicate messages from being processed from a gateway. 
 
@return LastSquence Defines if the gateway will trigger communication sequence when it receives an aware message. Default: true 
 
@return NetworkListInterval Defines in minutes the frequency that the gateway will request a new sensor list from the server. Default: 720 
 
@return ObserveAware Tells the server that there are configurations that have been updated in the data store and it should push a new configuration page down to the gateway. 
 
@return PendingActionControlCommand If set this flag will cause the action control command will be sent to the sensor 
 
@return PollInterval Defines in minutes the interval at which the gateway polls the server to check if urgent traffic exists for the gateway. 
 
@return Port Defines the port the server is listening for communication. Default: 3000 
 
@return PreSharedKey Defines pre-shared key used to initiate encryption for communication to server. Must match key in gateway configuration. Default: null 
 
@return RadioFirmwareVersion Tracks the version of radio firmware. Some features are only available on certain firmware versions. 
 
@return ReportInterval Defines in minutes the interval at which the gateway communicates with the server. Unless triggered to communicate earlier, the gateway will initialize a communication cycle with the server with or without data from sensors to deliver. 
 
@return SecondaryDNS If static IP is set: This is the value of the secondary DNS server used to resolve the host address of the server. If server is defined with IP Address this value is not used. 
 
@return SendResetNetworkRequest Flag that indicates if the server should inform the gateway that the network should be reformed. Reforming the network consists of removing any sensors configured in the gateway, scanning and choosing a clear channel, and requesting the sensors to add back into the gateway. 
 
This is getSensorIDs, a member of class Gateway. 
 
@return ServerHostAddress Address of the server. This can be either a DNS resolvable host name, or an IP Address of the server. 
 

Informs the gateway to reform the sensor network by scanning to find an open channel then re-downloading the allowed sensor list.  
 
@param sensorID Removes Sensor from the AssignedSensor List 
 
@param actionControlCommands The action control command(s) that will be sent to the sensor 
 
This is setAutoConfigTime, a member of class Gateway. 
 
@param decryptFailureDate Hold time of previous decryption failure, ensures gateway can't continually send packets with wrong encryption scheme. Only allows one reset per hour. Default: null 
 
@param defaultrouterip If static IP is set: This is the value of the router address the gateway will send its data through to access the Internet. 
 
@param encryptionIV Holds Initialization Vector generated in handshake. Rotates with each gateway startup Default: null 
 
@param encryptionKey Holds encryption key generated in handshake. Rotates with each gateway startup Default: null 
 
@param externalIdentifier Differs by gateway type. One example is the Ethernet gateway stores it's MAC Address here 
 
@param gatewaydns If static IP is set: This is the value of the primary DNS server used to resolve the host address of the server. If server is defined with IP Address this value is not used. 
 
@param gatewayFirmwareVersion Tracks the version of gateway firmware. Some features are only available on certain gateway versions. 
 

sets the Numeric Identifier of the gateway @param gatewayID Numeric Identifier of the gateway. 
 
@param gatewayIP IP address of the gateway if applicable. Default: 0.0.0.0 will inform the gateway to use DHCP to obtain an IP Address. 
 
@param gatewaysubnet If static IP is set: This is the value of the subnet mask of the network the gateway is operating on. 
 
@param gatewayType Type of the gateway. Certain settings are interpreted differently for different types of gateways 
 
This is setGPSReportInterval, a member of class Gateway. 
 
@param hasurgenttraffic Flag that indicates if the server has urgent messages to deliver to the gateway. Responds to PollInterval for use in conjunction with Control Profile 
 
@param isdirty Record of the last message sequence received from the gateway. Used to prevent duplicate messages from being processed from a gateway. 
 
@param lastSequence Defines if the gateway will trigger communication sequence when it receives an aware message. Default: true 
 
@param networkListInterval Defines in minutes the frequency that the gateway will request a new sensor list from the server. Default: 720 
 
@param observeAware Tells the server that there are configurations that have been updated in the data store and it should push a new configuration page down to the gateway. 
 
@param pollInterval Defines in minutes the interval at which the gateway polls the server to check if urgent traffic exists for the gateway. 
 
@param port Defines the port the server is listening for communication. Default: 3000 
 
@param preSharedKey Defines pre-shared key used to initiate encryption for communication to server. Must match key in gateway configuration. Default: null 
 
@param radioFirmwareVersion Tracks the version of radio firmware. Some features are only available on certain firmware versions. 
 
@param reportInterval Defines in minutes the interval at which the gateway communicates with the server. Unless triggered to communicate earlier, the gateway will initialize a communication cycle with the server with or without data from sensors to deliver. 
 
@param secondarydns If static IP is set: This is the value of the secondary DNS server used to resolve the host address of the server. If server is defined with IP Address this value is not used. 
 
@param sendresetnetworkrequest Flag that indicates if the server should inform the gateway that the network should be reformed. Reforming the network consists of removing any sensors configured in the gateway, scanning and choosing a clear channel, and requesting the sensors to add back into the gateway. 
 
@param serverHostAddress Address of the server. This can be either a DNS resolvable host name, or an IP Address of the server. 
 

Update the IP information of the gateway (selected gateway types) @param staticIP IP the gateway will use on the local area network. @param subnet Subnet the gateway will use to communication on the local area network. @param defaultRouter Default router the gateway will send information to if it needs to communicate outside the local area network. @param primaryDNS DNS server used to lookup server host names. (Not used is host is configured with IP Address. @param secondaryDNS Secondary DNS server used to lookup host names if Primary DNS server is not available. 
 

Update the interval at which the gateway polls the server to discover if there is any urgent messages that need to be sent to the gateway. @param pollInterval Interval in minutes. 
 

Update the interval at which the gateway reports information to the server. @param reportInterval Interval in minutes. 
 

Update the information the gateway uses to communicate with the server @param host IP Address or DNS resolvable host name of the server to communicate with @param port Port of the server to communicate with 
Copyright (c) 2022. All rights reserved.
What do you think about this topic? Send feedback!