API for linking to the Huxley National Rail REST proxy for the retrieval of live National Rail data. Still needs work (sadly), but works well for the time being!

Dependencies:   EthernetInterface

National Rail Huxley Integration Interface

This API provides a clear link between the National Rail Huxley Integration JSON interface (available at https://huxley.unop.uk/), and mbed devices, over an Ethernet connection. This project is still very much a work-in-progress, but hopefully I will be able to provide a comprehensive method of retrieving live National Rail departures data in a simple and effective way.


--- a/departure_board.h	Thu Apr 21 13:32:54 2016 +0000
+++ b/departure_board.h	Thu Apr 21 15:02:20 2016 +0000
@@ -4,6 +4,9 @@
 #include "departure.h"
 #include <string>
+/** Departure_Board
+*   Contains information pertaining to an departure board; namely, a list of departures and a list of National Rail messages.
 class Departure_Board
@@ -13,12 +16,25 @@
     std::string* messages;
     int num_messages;
-    Departure_Board(Departure* _departures);
+    /** Departure_Board constructor
+    * @param _departures pointer to a list of departures
+    * @param _num_departures number of departures in that list
+    * @param _messages pointer to a list of messages
+    * @param _num_messages number of messages in that list
+    */
+    Departure_Board(Departure* _departures, const int& _num_departures, std::string* _messages, const int& _num_messages);
+    /** Departure_Board default constructor
+    */
+    /** Departure_Board destructor
+    */
+/** Creates a Departure_Board object from a JSON object string. Uses the MbedJSONValue library.
+* @param jsonObject the JSON object to be parsed
+* @return a Departure_Board object containing the information from the JSON object string
 Departure_Board depBoardFromJson(const std::string& jsonObject);
\ No newline at end of file