XDK API  3.6.0
Documentation
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 DEST_GET_PATH   "/get"
 
#define DEST_POST_PATH   "/post"
 
#define DEST_SERVER_HOST   "postman-echo.com"
 
#define DEST_SERVER_PORT   UINT16_C(80)
 
#define DEST_SERVER_PORT_SECURE   UINT16_C(443)
 
#define HTTP_SECURE_ENABLE   UINT32_C(0)
 
#define INTER_REQUEST_INTERVAL   UINT32_C(10000)
 
#define POST_REQUEST_BODY   "{ \"device\": \"XDK110\", \"ping\": \"pong\" }"
 
#define POST_REQUEST_CUSTOM_HEADER_0   "X-AuthToken: InsertCrypticAuthenticationToken\r\n"
 
#define POST_REQUEST_CUSTOM_HEADER_1   "X-Foobar: AnotherCustomHeader\r\n"
 
#define REQUEST_MAX_DOWNLOAD_SIZE   UINT32_C(512)
 
#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 DEST_GET_PATH   "/get"

DEST_GET_PATH is the path relative to the DEST_SERVER_HOST that we will send the HTTP GET request to. Using / will retrieve the index page of the web server which for demo purposes may be enough.

Change this value if you use your own web server.

#define DEST_POST_PATH   "/post"

DEST_POST_PATH is the path relative to the DEST_SERVER_HOST that we will send the HTTP POST request to.

Change this value if you use your own web server.

#define DEST_SERVER_HOST   "postman-echo.com"

DEST_SERVER_HOST is the host name of the web server we will send HTTP requests to. If you want to test this example without setting up your own server, you can use publicly available services.

#define DEST_SERVER_PORT   UINT16_C(80)

DEST_SERVER_PORT is the TCP port to which we will send HTTP requests to. The default of 80 should be fine for most applications.

#define DEST_SERVER_PORT_SECURE   UINT16_C(443)

DEST_SERVER_PORT_SECURE is the TCP port to which we will send HTTPS requests to. The default of 443 should be fine for most applications.

#define HTTP_SECURE_ENABLE   UINT32_C(0)

HTTP_SECURE_ENABLE is Set to Use HTTP With Security

#define INTER_REQUEST_INTERVAL   UINT32_C(10000)

The time we wait (in milliseconds) between sending HTTP requests.

#define POST_REQUEST_BODY   "{ \"device\": \"XDK110\", \"ping\": \"pong\" }"

POST_REQUEST_BODY is sent as body with the HTTP POST request

#define POST_REQUEST_CUSTOM_HEADER_0   "X-AuthToken: InsertCrypticAuthenticationToken\r\n"

POST_REQUEST_CUSTOM_HEADER_0 is a custom header which is sent along with the POST request. It's meant to demonstrate how to use custom header.

#define POST_REQUEST_CUSTOM_HEADER_1   "X-Foobar: AnotherCustomHeader\r\n"

POST_REQUEST_CUSTOM_HEADER_1 is a custom header which is sent along with the POST request. It's meant to demonstrate how to use custom header.

#define REQUEST_MAX_DOWNLOAD_SIZE   UINT32_C(512)

The maximum amount of data we download in a single request (in bytes). This number is limited by the platform abstraction layer implementation that ships with the XDK. The maximum value that will work here is 512 bytes.

#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.


All rights reserved. The use is subject to the XDK SDK EULA by Bosch Connected Devices and Solutions GmbH.
This documentation file has been automatically generated on Thu Mar 14 2019 19:12:39 by doxygen 1.8.8