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.

/media/uploads/Leigh_LbR/nre_powered_logo.jpg

Revision:
4:7e8a23454d85
Parent:
2:071bf3c7f2a2
Child:
8:6e063a3827c0
diff -r a287e75a2121 -r 7e8a23454d85 nr_network.h
--- a/nr_network.h	Thu Apr 21 13:32:54 2016 +0000
+++ b/nr_network.h	Thu Apr 21 15:02:20 2016 +0000
@@ -41,7 +41,17 @@
     /** Disconnect from the API
     */
     void Disconnect();
+    /** Request a list of arrivals from the API and format them into an Arrival_Board object.
+    * @param code_stn the station code to get arrivals from
+    * @param number the number of arrivals to retrieve
+    * @return an Arrival_Board object containing all the arrivals to this station
+    */
     Arrival_Board GetArrivals(const std::string& code_stn, const std::string& number);
+    /** Request a list of departures from the API and format them into a Departure_Board object.
+    * @param code_stn the station code to get departures from
+    * @param number the number of departures to retrieve
+    * @return a Departure_Board object containing all the departures from this station
+    */
     Departure_Board GetDepartures(const std::string& code_stn, const std::string& number);
 };