Doxygen/Docbook Link Test
 All Data Structures Functions Variables Typedefs Modules Pages
CAppConfig Struct Reference

#include <config_app.h>

Data Fields

CTCPConnectionContainer * cc
 
CTCPClient * client
 
int useWebsocket
 
int useSsl
 
char * hostname
 
char * portname
 
char * domain
 
char * username
 
char * password
 
int pwtype
 
int pollUsecs
 
int retrySecs
 
int disconnectSecs
 
MSCLOCK heartbeat
 
MSCLOCK timeout
 
MSCLOCK retry
 
int heapBytes
 
char * modbusHost
 
char * modbusPort
 
int modbusSlaveId
 
int modbusPollMs
 
ULONG macAddressLsw
 
ULONG macAddressMsw
 

Detailed Description

Defines an application-specific structure containing information that is required during start-up. In the example code, this information is supplied in config_app.c. In other instances this information might be stored as persistent configuration in flash memory. An application developer should add or remove members in this structure to suit the application requirements.

Field Documentation

CTCPConnectionContainer* CAppConfig::cc

Needed by many ETK API calls

CTCPClient* CAppConfig::client

The client that connects to the DataHub or SkkyHub server

int CAppConfig::disconnectSecs

The number of seconds to wait before disconnecting after a connection to the server is made. This has the effect of periodically connecting and updating data, then disconnecting again.

char* CAppConfig::domain

The data domain into which data will be stored

int CAppConfig::heapBytes

Internal. Holds the configured heap size.

MSCLOCK CAppConfig::heartbeat

The keep-alive heartbeat rate

char* CAppConfig::hostname

The name of the DataHub/SkkyHub server

ULONG CAppConfig::macAddressLsw

The MAC address low 32 bits

ULONG CAppConfig::macAddressMsw

The MAC address high 16 bits. The high 16 bits of this value must be zero

char* CAppConfig::modbusHost

The address of the Modbus slave device

int CAppConfig::modbusPollMs

The number of milliseconds between Modbus polls

char* CAppConfig::modbusPort

The port number (as a string) for the Modbus slave device

int CAppConfig::modbusSlaveId

The Modbus slave ID (1-254)

char* CAppConfig::password

The password for authentication on the server

int CAppConfig::pollUsecs

The number of microseconds per poll. ThreadX has a 10ms tick, so this should be a multiple of 10000

char* CAppConfig::portname

The port number (as a string) to connect to on the DataHub/SkkyHub server

int CAppConfig::pwtype

The type of password encoding

MSCLOCK CAppConfig::retry

Internal. Use retrySecs instead.

int CAppConfig::retrySecs

The number of seconds between socket connection re-tries when connecting to the server

MSCLOCK CAppConfig::timeout

The keep-alive timeout. If no data or heartbeat is received from the server within this time, disconnect the socket.

char* CAppConfig::username

The user name for authentication on the server

int CAppConfig::useSsl

0 or 1, indicating whether to use SSL (not implemented)

int CAppConfig::useWebsocket

0 or 1, indicating whether to connect using WebSocket


The documentation for this struct was generated from the following file: