Task/change server name (#81)

* server name to "insert_host" * remove from doc Co-authored-by: srdjanStankovic <srdjanrstankovic@gmail.com>
Wolkabout · May 23, 2022 · 4cbc7a5 · 4cbc7a5
1 parent 90014c7
commit 4cbc7a5
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 17 deletions.
diff --git a/README.md b/README.md
@@ -15,7 +15,7 @@
 ```
 [![Build Status](https://travis-ci.com/Wolkabout/WolkConnect-C.svg?branch=master)](https://travis-ci.com/Wolkabout/WolkConnect-C)
 -----
-WolkAbout C99 Connector library for connecting devices to [WolkAbout IoT platform](https://demo.wolkabout.com/#/login).
+WolkAbout C99 Connector library for connecting devices to WolkAbout IoT platform instance.
 
 WolkConnect-C is transportation layer agnostic which means it is up to the user of the library to open socket to WolkAbout IoT platform,
 configure SSL if desired, and forward read/write implementation to WolkConnect-C Connector.
@@ -61,11 +61,12 @@ Create a device on WolkAbout IoT platform using `Simple example` device type.
 This device type fits [simple example](https://github.com/Wolkabout/WolkConnect-C/blob/master/examples/simple/main.c) and demonstrates the periodic sending of a temperature sensor reading.
 
 ```c
-static const char* device_key = "device_key";
-static const char* device_password = "some_password";
-static const char* hostname = "api-demo.wolkabout.com";
-static int portno = 8883;
-static char certs[] = "../ca.crt";
+/* WolkAbout Platform device connection parameters */
+static const char* device_key       = "device_key";
+static const char* device_password  = "some_password";
+static const char* hostname         = "insert_host";
+static int portno                   = 80; // TODO: insert port
+static char certs[]                 = "../ca.crt";
 
 /* Sample in-memory persistence storage - size 1MB */
 static uint8_t persistence_storage[1024*1024];

diff --git a/docs/templates/WolkConnect-Functional-Documentation.md b/docs/templates/WolkConnect-Functional-Documentation.md
@@ -1,6 +1,6 @@
 
 
-WolkConnect libraries are used to enable a device’s communication with [WolkAbout IoT Platform](https://demo.wolkabout.com/#/login).
+WolkConnect libraries are used to enable a device’s communication with WolkAbout IoT platform instance.
 Using WolkConnect libraries in the software or firmware of a device will drastically decrease the time to market for developers or anyone wanting to integrate their own product with WolkAbout IoT Platform.
 
 WolkConnect libraries are intended to be used on IP enabled devices. The available WolkConnect libraries (implemented in the following programming languages [C](https://github.com/Wolkabout/WolkConnect-C), [C++](https://github.com/Wolkabout/WolkConnect-Cpp), [Java](https://github.com/Wolkabout/WolkConnect-Java-), [Python](https://github.com/Wolkabout/WolkConnect-Python), [Node-RED](https://github.com/Wolkabout/WolkConnect-Node-RED)) are platform independent for OS based devices, with a special note that the WolkConnect-C library is suitable to be adapted for the use on non-OS devices as WolkConnect libraries have a small memory footprint. More hardware specific WolkConnect libraries are available for [Arduino](https://github.com/Wolkabout/WolkConnect-Arduino), [MicroPython](https://github.com/Wolkabout/WolkConnect-MicroPython) and [Zerynth](https://github.com/Wolkabout/wolkabout-iot).

diff --git a/examples/full_feature_set/README.md b/examples/full_feature_set/README.md
@@ -15,7 +15,7 @@
 ```
 [![Build Status](https://travis-ci.com/Wolkabout/WolkConnect-C.svg?branch=master)](https://travis-ci.com/Wolkabout/WolkConnect-C)
 -----
-WolkAbout C99 Connector library for connecting devices to [WolkAbout IoT platform](https://demo.wolkabout.com/#/login).
+WolkAbout C99 Connector library for connecting devices to WolkAbout IoT platform instance.
 
 WolkConnect-C is transportation layer agnostic which means it is up to the user of the library to open socket to WolkAbout IoT platform,
 configure SSL if desired, and forward read/write implementation to WolkConnect-C Connector.
@@ -54,11 +54,12 @@ Create a device on WolkAbout IoT platform using [Full example](https://github.co
 **Establishing connection with WolkAbout IoT platform:**
 
 ```c
-static const char* device_key = "device_key";
-static const char* device_password = "some_password";
-static const char* hostname = "api-demo.wolkabout.com";
-static int portno = 8883;
-static char certs[] = "../ca.crt";
+/* WolkAbout Platform device connection parameters */
+static const char* device_key       = "device_key";
+static const char* device_password  = "some_password";
+static const char* hostname         = "insert_host";
+static int portno                   = 80; // TODO: insert port
+static char certs[]                 = "../ca.crt";
 
 /* Sample in-memory persistence storage - size 1MB */
 static uint8_t persistence_storage[1024 * 1024];

diff --git a/examples/full_feature_set/main.c b/examples/full_feature_set/main.c
@@ -39,8 +39,8 @@ static BIO* sockfd;
 /* WolkAbout Platform device connection parameters */
 static const char* device_key = "device_key";
 static const char* device_password = "some_password";
-static const char* hostname = "api-demo.wolkabout.com";
-static int portno = 8883;
+static const char* hostname = "insert_host";
+static int portno = 80; // TODO: insert port
 static char certs[] = "../ca.crt";
 
 /* Sample in-memory persistence storage - size 1MB */

diff --git a/examples/simple/main.c b/examples/simple/main.c
@@ -32,10 +32,11 @@
 static SSL_CTX* ctx;
 static BIO* sockfd;
 
+/* WolkAbout Platform device connection parameters */
 static const char* device_key = "device_key";
 static const char* device_password = "some_password";
-static const char* hostname = "api-demo.wolkabout.com";
-static int portno = 8883;
+static const char* hostname = "insert_host";
+static int portno = 80; // TODO: insert port
 static char certs[] = "../ca.crt";
 
 /* Sample in-memory persistence storage - size 1MB */