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.


diff -r a287e75a2121 -r 7e8a23454d85 arrival_board.h
--- a/arrival_board.h	Thu Apr 21 13:32:54 2016 +0000
+++ b/arrival_board.h	Thu Apr 21 15:02:20 2016 +0000
@@ -16,12 +16,26 @@
     std::string* messages;
     int num_messages;
+    /** Arrival_Board constructor
+    * @param _arrivals pointer to a list of arrivals
+    * @param _num_arrivals number of arrivals in that list
+    * @param _messages pointer to a list of messages
+    * @param _num_messages number of messages in that list
+    */
     Arrival_Board(Arrival* _arrivals, const int& _num_arrivals, std::string* _messages, const int& _num_messages);
+    /** Arrival_Board default constructor
+    */
+    /** Arrival_Board destructor
+    */
+/** Creates an Arrival_Board object from a JSON object string. Uses the MbedJSONValue library.
+* @param jsonObject the JSON object to be parsed
+* @return an Arrival_Board object containing the information from the JSON object string
 Arrival_Board arrBoardFromJson(const std::string& jsonObject);
\ No newline at end of file