Gateway Members

The following tables list the members exposed by Gateway.

	Name	Description
	AutoConfigCommandTime	Allows the Gateway to grab sensors that are not in it's sensor list for a specific amount of time in minutes
	CellAPNName	This is a name assigned by the cellular provider for their specific m2m network.
	ChannelMask	private ListRegisteredSensors; Missing Attributes * The Channel that the Radio talks over if set the gateway will ever only talk on that channel defaults allows the channel change when the gateway is reformed.
	DefaultRouterIP	The IP address of the router that the gateway funnels network traffic to
	DisableNetworkOnServerError	If the network connection is not available, the gateway will disable the sensor network allowing sensors to relink to a different gateway.
	ExternalIdentifier	This is ExternalIdentifier, a member of class Gateway.
	GatewayDNS	The primary IP address of a DNS server the Gateway can use to get it's IP address from
	GatewayFirmwareVersion	The specific firmware version the APN of the gateway uses this is separate from the RadioFirmwareVersion
	GatewayID	The unique identifier for the gateway
	GatewayIP	The IP address of the gateway
	GatewayPowerMode	Type of power mode used by the gateway determines the value of a charging battery
	GatewaySubnet	The subnet mask for the gateway. used specifically for cell gateways and Ethernet gateways.
	GatewayType	The specific type of gateway such as CGW3, Ethernet, USB.
	HasUrgentTraffic	this lets the gateway know if it has a control or local notifier message
	IsDirty	Allows the System to know when to update the gateway
	NetworkIDFilter	This is NetworkIDFilter, a member of class Gateway.
	Password	Some data networks will require a username and sometimes a password for cell gateways this stores the Password
	PendingActionControlCommand	this is set for a gateway if there is an ACC that should be pushed to the gateway.
	PollInterval	polls the server to find out if there is any data that needs to be sent down to the sensors this includes but is not limited to updates and notifications this does not send up sensor data collected by the gateway
	Port	The Primary port of the Server that the gateway will be talking to.
	Port2	The Secondary port for a gateway to send sensor data through
	PowerSourceID	22 system power supply 1-Line Power, 2-Battery, 3-Battery and GPS
	RadioFirmwareVersion	The specific firmware version the radio on the gateway is using
	ReportInterval	This is how often the gateway will pass data to the Server collecting sensor data
	SecondaryDNS	The secondary IP address of a DNS server the Gateway can use to get it's IP address from
	SendResetNetworkRequest	Sets the gateway to reform the network it is on changes the channel and clears and re-downloads the gateway list
	SensorID	This is SensorID, a member of class Gateway.
	ServerHostAddress	the Primary host address that the gateway will be talking to.
	ServerHostAddress2	The Secondary host address for a gateway to send sensor data through
	SingleQueueExpiration	This is SingleQueueExpiration, a member of class Gateway.
	Username	Some data networks will require a username and sometimes a password for cell gateways this stores the Username

Public Methods

	Name	Description
	addActionControlCommand	allows you to add a single byte array to your action control command @param comm is a byte array command for a gateway
	BatteryPercentageHelper	This is the overview for the BatteryPercentageHelper method overload.
	ForceConfiguration	sets the isdirty flag to true
	Gateway	This is the overview for the Gateway constructor overload.
	getActionControlCommands	gets a list of byte arrays that are the action control commands for the gateway
	getAutoConfigCommand	This is getAutoConfigCommand, a member of class Gateway.
	getAutoConfigTime	This is getAutoConfigTime, a member of class Gateway.
	getDecryptFailureDate	This is getDecryptFailureDate, a member of class Gateway.
	getDefaultRouterIP	gets the Router Address the gateway will use to pass traffic through
	getEncryptionIV	This is getEncryptionIV, a member of class Gateway.
	getEncryptionKey	This is getEncryptionKey, a member of class Gateway.
	getExternalIdentifier	This is getExternalIdentifier, a member of class Gateway.
	getGatewayDNS	gets the primary dns of the gateway
	getGatewayFirmwareVersion	gets the APN firmware version of the gateway @return gets the version as a string
	getGatewayID	Gets the Gateways unique identifier @return gateway id as an integer
	getGatewayIP	gets the gateways IP address
	getGatewaySubnet	gets the SubNetMask of the gateway
	getGatewayType	gets the gateways type @return the gateway type as an eGatewayType
	getGPSReportInterval	This is getGPSReportInterval, a member of class Gateway.
	getHasUrgentTraffic	This is getHasUrgentTraffic, a member of class Gateway.
	getIsDirty	gets if the sensor needs to be updated or not
	getLastSequence	This is getLastSequence, a member of class Gateway.
	getNetworkListInterval	gets how often the gateway will get the sensor list updated
	getObserveAware	gets weather or not the gateway uses observeAware
	getPendingActionControlCommand	This is getPendingActionControlCommand, a member of class Gateway.
	getPollInterval	gets the poll interval
	getPort	gets the primary port the gateway will send data through
	getPreSharedKey	gets the pre-shared key that should be on the gateway
	getRadioFirmwareVersion	gets the Radio Firmware Version of the gateway @return brings back the version as a string
	getReportInterval	gets the report interval of the gateway
	getSecondaryDNS	gets the secondary dns of the gateway
	getSendResetNetworkRequest	This is getSendResetNetworkRequest, a member of class Gateway.
	getServerHostAddress	gets the primary server host address the gateway sends data to
	ReformNetwork	Reforms the gateways network updating the gateways channel and re-downloading the sensor list for the gateway
	setActionControlCommands	sets action control commands for the gateway @param actionControlCommands is a list of byte arrays
	setAutoConfigTime	This is setAutoConfigTime, a member of class Gateway.
	setDecryptFailureDate	This is setDecryptFailureDate, a member of class Gateway.
	setGPSReportInterval	This is setGPSReportInterval, a member of class Gateway.
	setIsDirty	sets if the gateway should be updated or not @param isdirty allows the system to know if the gateway should be updated or not
	setLastSequence	This is setLastSequence, a member of class Gateway.
	setNetworkListInterval	Sets how often the gateway list with be updated @param networkListInterval how often in minutes the gateway will get an updated sensor list
	setObserveAware	sets if the gateway should observe the aware state of a sensor @param observeAware if true will send all data being held regardless of report interval
	setPort
	UpdateGatewayIP	updates everything needed to change the gateway IP @param staticIP Static IP address that the gateway should be set to @param subnet The SubNetMask of the gateway @param defaultRouter The IP address of the router the gateway should be talking through @param primaryDNS The primary DNS IP address @param secondaryDNS The secondary DNS IP address
	UpdatePollInterval	updates the poll interval of the gateway @param pollInterval the value in minutes of how often the gateway should check for messages from the server
	UpdateReportInterval	updates the gateways heartbeat in minutes @param reportInterval the heartbeat value in minutes the gateway should be updated to.
	UpdateServerInformation	updates the host and port on the gateway @param host is the primary host address that the gateway should talk to @param port is the primary port the gateway should talk to

Links

Gateway Class, Legend, Public Fields, Public Methods

Contents | Index | Home

What do you think about this topic? Send feedback!