Macros | Functions
AppController.h File Reference

Configuration header for the AppController.c file. More...

#include "XDK_Utils.h"
+ Include dependency graph for AppController.h:
+ This graph shows which files directly or indirectly include this file:

Macros

#define APP_POST_INTERVAL_MS   UINT32_C(10000)
 
#define APP_PPMP_DEVICE_ID   "YourPPMPDeviceId"
 
#define APP_SENSOR_ACCEL   true
 
#define APP_SENSOR_GYRO   true
 
#define APP_SENSOR_HUMIDITY   true
 
#define APP_SENSOR_LIGHT   true
 
#define APP_SENSOR_MAG   true
 
#define APP_SENSOR_NOISE   false
 
#define APP_SENSOR_PRESSURE   true
 
#define APP_SENSOR_TEMP   true
 
#define APP_SYNC_TIME_FOR_EVERY_POST   false
 
#define APP_SYNC_TIME_INTERVAL_MAX_MS   UINT32_C(1800000)
 
#define APP_TEMPERATURE_OFFSET_CORRECTION   (-3459)
 
#define PPMP_POST_URL_MEASUREMENT   "/ppm/v2/measurement"
 
#define PPMP_POST_URL_MESSAGE   "/ppm/v2/message"
 
#define PPMP_SERVER_PORT   UINT16_C(80)
 
#define PPMP_SERVER_URL   "YourPPMPServerURL"
 
#define SNTP_SERVER_PORT   UINT16_C(123)
 
#define SNTP_SERVER_URL   "YourSNTPServerURL"
 
#define WLAN_DNS_ADDR   XDK_NETWORK_IPV4(0, 0, 0, 0)
 
#define WLAN_GW_ADDR   XDK_NETWORK_IPV4(0, 0, 0, 0)
 
#define WLAN_IP_ADDR   XDK_NETWORK_IPV4(0, 0, 0, 0)
 
#define WLAN_MASK   XDK_NETWORK_IPV4(0, 0, 0, 0)
 
#define WLAN_PSK   "YourWifiPassword"
 
#define WLAN_SSID   "YourWifiNetwork"
 
#define WLAN_STATIC_IP   false
 

Functions

void AppController_Init (void *CmdProcessorHandle, uint32_t param2)
 Gives control to the Application controller. More...
 

Macro Definition Documentation

#define APP_POST_INTERVAL_MS   UINT32_C(10000)

APP_POST_INTERVAL_MS is the interval at which the PPMP payload's are to be periodically POSTed to the server.

#define APP_PPMP_DEVICE_ID   "YourPPMPDeviceId"

APP_PPMP_DEVICE_ID is the unique name per XDK PPMP node. Make sure to update the APP_PPMP_DEVICE_ID value.

#define APP_SENSOR_ACCEL   true

APP_SENSOR_ACCEL is a boolean. If "true" then Accel sensor data is communicated to the server and if "false" not

#define APP_SENSOR_GYRO   true

APP_SENSOR_GYRO is a boolean. If "true" then Gyro sensor data is communicated to the server and if "false" not

#define APP_SENSOR_HUMIDITY   true

APP_SENSOR_HUMIDITY is a boolean. If "true" then Humidity sensor data is communicated to the server and if "false" not

#define APP_SENSOR_LIGHT   true

APP_SENSOR_LIGHT is a boolean. If "true" then Light sensor data is communicated to the server and if "false" not

#define APP_SENSOR_MAG   true

APP_SENSOR_MAG is a boolean. If "true" then Mag sensor data is communicated to the server and if "false" not

#define APP_SENSOR_NOISE   false

APP_SENSOR_NOISE is a boolean. If "true" then Noise sensor data is communicated to the server and if "false" not

#define APP_SENSOR_PRESSURE   true

APP_SENSOR_PRESSURE is a boolean. If "true" then Pressure sensor data is communicated to the server and if "false" not

#define APP_SENSOR_TEMP   true

APP_SENSOR_TEMP is a boolean. If "true" then Temperature sensor data is communicated to the server and if "false" not

#define APP_SYNC_TIME_FOR_EVERY_POST   false

APP_SYNC_TIME_FOR_EVERY_POST is a boolean defining if SNTP time needs to be synced with external PPMP server prior to every single POST.

#define APP_SYNC_TIME_INTERVAL_MAX_MS   UINT32_C(1800000)

APP_SYNC_TIME_INTERVAL_MAX_MS is the synchronization time with SNTP server. Make sure to update the APP_SYNC_TIME_INTERVAL_MAX_MS value, if APP_SYNC_TIME_FOR_EVERY_POST is "false".

#define APP_TEMPERATURE_OFFSET_CORRECTION   (-3459)

APP_TEMPERATURE_OFFSET_CORRECTION is the Temperature sensor offset correction value (in mDegC). Unused if APP_SENSOR_TEMP is false. This is the Self heating, temperature correction factor.

#define PPMP_POST_URL_MEASUREMENT   "/ppm/v2/measurement"

PPMP_POST_URL_MEASUREMENT is the PPMP payload POST URL for measurements.

#define PPMP_POST_URL_MESSAGE   "/ppm/v2/message"

PPMP_POST_URL_MESSAGE is the PPMP payload POST URL for messages.

#define PPMP_SERVER_PORT   UINT16_C(80)

PPMP_SERVER_PORT is the PPMP server port number.

#define PPMP_SERVER_URL   "YourPPMPServerURL"

PPMP_SERVER_URL is the PPMP server URL. Make sure to update the PPMP_SERVER_URL value, if APP_USE_SERVER_URL is "true".

#define SNTP_SERVER_PORT   UINT16_C(123)

SNTP_SERVER_PORT is the SNTP server port number.

#define SNTP_SERVER_URL   "YourSNTPServerURL"

SNTP_SERVER_URL is the SNTP server URL.

#define WLAN_DNS_ADDR   XDK_NETWORK_IPV4(0, 0, 0, 0)

WLAN_DNS_ADDR is the WIFI router WPA/WPA2 static IPv4 DNS address (unused if WLAN_STATIC_IP is false) Make sure to update the WLAN_DNS_ADDR constant according to your required WIFI network, if WLAN_STATIC_IP is "true".

#define WLAN_GW_ADDR   XDK_NETWORK_IPV4(0, 0, 0, 0)

WLAN_GW_ADDR is the WIFI router WPA/WPA2 static IPv4 gateway address (unused if WLAN_STATIC_IP is false) Make sure to update the WLAN_GW_ADDR constant according to your required WIFI network, if WLAN_STATIC_IP is "true".

#define WLAN_IP_ADDR   XDK_NETWORK_IPV4(0, 0, 0, 0)

WLAN_IP_ADDR is the WIFI router WPA/WPA2 static IPv4 IP address (unused if WLAN_STATIC_IP is false) Make sure to update the WLAN_IP_ADDR constant according to your required WIFI network, if WLAN_STATIC_IP is "true".

#define WLAN_MASK   XDK_NETWORK_IPV4(0, 0, 0, 0)

WLAN_MASK is the WIFI router WPA/WPA2 static IPv4 mask address (unused if WLAN_STATIC_IP is false) Make sure to update the WLAN_MASK constant according to your required WIFI network, if WLAN_STATIC_IP is "true".

#define WLAN_PSK   "YourWifiPassword"

WLAN_PSK is the WIFI router WPA/WPA2 password used at the Wifi network connection. Make sure to update the WLAN_PSK constant according to your router password.

#define WLAN_SSID   "YourWifiNetwork"

WLAN_SSID is the WIFI network name where user wants connect the XDK device. Make sure to update the WLAN_PSK constant according to your required WIFI network.

#define WLAN_STATIC_IP   false

WLAN_STATIC_IP is a boolean. If "true" then static IP will be assigned and if "false" then DHCP is used.


This documentation file has been automatically generated on Wed May 6 2020 20:45:05 by doxygen 1.8.8