Leigh Brooks / HuxleyIntegrationAPI

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

nr_network.h

Committer:
Leigh_LbR
Date:
2016-04-21
Revision:
4:7e8a23454d85
Parent:
2:071bf3c7f2a2
Child:
8:6e063a3827c0

File content as of revision 4:7e8a23454d85:

#ifndef NR_NETWORK_H
#define NR_NETWORK_H

#include "arrival_board.h"
#include "departure_board.h"
#include "EthernetInterface.h"
#include <string>

/** NR_Network_Conn
*   Used for establishing a connection to the Huxley NR SOAP proxy and to generate departure/arrivals data
*/
class NR_Network_Conn
{
private:
    void init(const char* address, const char* mask, const char* gateway);
    EthernetInterface conn;
    TCPSocketConnection socket;
    char _address[17];
    char _sub_mask[17];
    char _gateway[17];

public:
    /** Make a connection. The empty constructor creates a connection using DHCP.
    */
    NR_Network_Conn();
    /** Make a connection. This constructor creates a connection with the specified IP address, subnet and gateway
    * @param address the IP address of this device (in the format "192.168.1.101"
    * @param mask the subnet mask of this device (in the format "255.255.255.0"
    * @param gateway the gatway of this device (in the format "192.168.1.1"
    */
    NR_Network_Conn(const char* address, const char* mask, const char* gateway);
    /** Get the socket (an object of type TCPSocketConnection)
    */
    TCPSocketConnection GetSocket();
    /** Get the IP address of the current connection
    */
    char* GetIP();
    /** Establish a connection to the API
    */
    int Connect();
    /** 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);
};

#endif