The Gateway type exposes the following members.

Constructors

  Name Description
Public method Gateway(UInt32, eGatewayType, String, String, String, Int32)
Presets these properties GatewayType GatewayFirmwareVersion RadioFirmwareVersion Host Port Sets all other properties to default values
Public method Gateway(UInt32, eGatewayType, String, String, String, Int32, Double, Boolean, Double, Boolean, String, String, String, String, String)
Presets these properties GatewayType GatewayFirmwareVersion RadioFirmwareVersion Host Port You can selectively set these properties ReportInterval (Default: 5) ObserveAware (Default: true) PollInterval (Default: 0 Not Enabled) HasUrgentTraffic (Default: false) GatewayIP (Default: "0.0.0.0" Use DHCP) GatewaySubnet (Default: "0.0.0.0") DefaultRouterIP (Default: "0.0.0.0") GatewayDNS (Default: "0.0.0.0") SecondaryDNS (Default: "0.0.0.0") Sets all other properties to default values

Methods

  Name Description
Public method AssignSensor
Assign a sensor to this gateway
Public method Static member BatteryPercentageHelper(eGatewayBattery, Double)
Returns an estimated percent of remaining battery based on pre-configured battery profiles
Public method Static member BatteryPercentageHelper(Double, Double, Double, Double, Double, Double, Double)
Returns an estimated percent of remaining battery based on linear interpolation between defined percentage points
Public method Equals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected method Finalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public method ForceConfiguration
Force server held configurations to be sent to the gateway at the next communication cycle.
Public method GetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public method GetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected method MemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public method ReformNetwork
Informs the gateway to reform the sensor network by scanning to find an open channel then re-downloading the allowed sensor list.
Public method RemoveSensor
Remove a sensor assignment from this gateway
Public method ToString
Returns a string that represents the current object.
(Inherited from Object.)
Public method UpdateGatewayIP
Update the IP information of the gateway (selected gateway types)
Public method UpdatePollInterval
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.
Public method UpdateReportInterval
Update the interval at which the gateway reports information to the server.
Public method UpdateServerInformation
Update the information the gateway uses to communicate with the server

Properties

  Name Description
Public property AssignedSensors
List of sensor ids that have been assigned to this gateway
Public property 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.
Public property ExternalIdentifier
Differs by gateway type. One example is the Ethernet gateway stores it's MAC Address here
Public property 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.
Public property GatewayFirmwareVersion
Tracks the version of gateway firmware. Some features are only available on certain gateway versions.
Public property GatewayID
Numeric Identifier of the gateway.
Public property 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.
Public property GatewaySubnet
If static IP is set: This is the value of the subnet mask of the network the gateway is operating on.
Public property GatewayType
Type of the gateway. Certain settings are interpreted differently for different types of gateways
Public property 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
Public property IsDirty
Record of the last message sequence received from the gateway. Used to prevent duplicate messages from being processed from a gateway.
Public property PollInterval
Defines in minutes the interval at which the gateway polls the server to check if urgent traffic exists for the gateway.
Public property Port
Defines the port the server is listening for communication. Default: 3000
Public property RadioFirmwareVersion
Tracks the version of radio firmware. Some features are only available on certain firmware versions.
Public property 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.
Public property 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.
Public property 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.
Public property ServerHostAddress
Address of the server. This can be either a DNS resolvable host name, or an IP Address of the server.

See Also