Merge branch 'main' of https://github.com/snorklerjoe/CubeServer-api-arduino

Author: snorklerjoe

README.md

@@ -1,7 +1,78 @@
 # CubeServer-api-arduino
 [![Maintainability](https://api.codeclimate.com/v1/badges/3637b71abcbcb0d8c30b/maintainability)](https://codeclimate.com/github/snorklerjoe/CubeServer-api-arduino/maintainability)
 
-An arduino-C implementation of the API wrapper for this project
+An arduino-C implementation of the API wrapper for CubeServer
 
-This currently only supports ESP8266, and only sort of...
-(In development!)
+_This currently only supports ESP8266 (It's in development!)_
+
+----------------------------------------------------------------
+
+## Example Sketches
+(client_config.h is downloaded from the CubeServer webapp):
+
+Bare minimum:
+``` C++
+#include <Arduino.h>
+#include <server.h>
+#include "client_config.h"
+
+CubeServer server(TEAM_NAME, TEAM_SECRET, SERVER_FINGERPRINT);
+
+void setup() {
+  server.connect();
+  server.postTemperature(32);
+}
+
+void loop() {
+}
+
+```
+
+Advanced features demonstrated:
+``` C++
+#include <Arduino.h>
+#include <server.h>
+#include "client_config.h"
+
+CubeServer server(TEAM_NAME, TEAM_SECRET, SERVER_FINGERPRINT);
+
+int code;
+GameStatus stats;
+
+bool connecting_loop() {
+  delay(100);
+  Serial.print(".");
+  return true;
+}
+
+void setup() {
+  Serial.begin(115200);
+  Serial.println("Connecting...");
+  code = server.connect(&connecting_loop);
+  if(code >= 0)
+    Serial.println("Connected!");
+  else
+    Serial.println("Could not connect to the server.");
+
+  code = server.get_status(&stats);
+  if(code == 200)
+    Serial.printf("Time: %i; Score: %i; Strikes: %i;\n", stats.unix_time, stats.score, stats.strikes);
+  else
+    Serial.println("There was an issue connecting to the server.");
+
+
+  Serial.println("Posting some data:");
+  code = server.postHumidity(99.99);
+  //code = server.postTemperature(32);
+  //code = server.postLightIntensity(12.5);
+  //code = server.postPressure(25.2);
+  //code = server.postComment("Hello World!");
+  if(code == 201)
+    Serial.println("Data posted successfully!");
+  else
+    Serial.println("There was a problem with posting the data.");
+}
+
+void loop() {
+}
+```