summaryrefslogtreecommitdiff
path: root/boards/dk-tm4c129x/qs_weather/eth_client.h
blob: cccff86a5bbe35799a3f9467486cc360f60e7e1e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
//*****************************************************************************
//
// eth_client.h - Prototypes for the driver for the eth_client
//
// Copyright (c) 2013-2014 Texas Instruments Incorporated.  All rights reserved.
// Software License Agreement
// 
// Texas Instruments (TI) is supplying this software for use solely and
// exclusively on TI's microcontroller products. The software is owned by
// TI and/or its suppliers, and is protected under applicable copyright
// laws. You may not combine this software with "viral" open-source
// software in order to form a larger program.
// 
// THIS SOFTWARE IS PROVIDED "AS IS" AND WITH ALL FAULTS.
// NO WARRANTIES, WHETHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING, BUT
// NOT LIMITED TO, IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE. TI SHALL NOT, UNDER ANY
// CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL, OR CONSEQUENTIAL
// DAMAGES, FOR ANY REASON WHATSOEVER.
// 
// This is part of revision 2.1.0.12573 of the DK-TM4C129X Firmware Package.
//
//*****************************************************************************
#ifndef ETH_CLIENT_H_
#define ETH_CLIENT_H_

//*****************************************************************************
//
// If building with a C++ compiler, make all of the definitions in this header
// have a C binding.
//
//*****************************************************************************
#ifdef __cplusplus
extern "C"
{
#endif

//*****************************************************************************
//
// Events passed back to the application.
//
//*****************************************************************************
#define ETH_EVENT_RECEIVE       0x00000001
#define ETH_EVENT_CONNECT       0x00000002
#define ETH_EVENT_DISCONNECT    0x00000003
#define ETH_EVENT_CLOSE         0x00000004
#define ETH_EVENT_INVALID_REQ   0x00000005

//*****************************************************************************
//
// The weather access methods.
//
//*****************************************************************************
typedef enum
{
    //
    // openweathermap.org.
    //
    iWSrcOpenWeatherMap
}
tWeatherSource;

//*****************************************************************************
//
// Generic weather reporting structure.
//
//*****************************************************************************
typedef struct
{
    //
    // The brief weather description, this is caller provided.
    //
    const char *pcDescription;

    //
    // The current temperature(units determined by caller).
    //
    int32_t i32Temp;

    //
    // The daily high temperature(units determined by caller).
    //
    int32_t i32TempHigh;

    //
    // The daily low temperature(units determined by caller).
    //
    int32_t i32TempLow;

    //
    // The current humidity(units determined by caller).
    //
    int32_t i32Humidity;

    //
    // The current atmospheric pressure(units determined by caller).
    //
    int32_t i32Pressure;

    //
    // The last time these values were update (GMT Unix time).
    //
    uint32_t ui32Time;

    //
    // The sunrise time (GMT Unix time).
    //
    uint32_t ui32SunRise;

    //
    // The sunset time (GMT Unix time).
    //
    uint32_t ui32SunSet;

    //
    // Icon image.
    //
    const uint8_t *pui8Image;
}
tWeatherReport;

//*****************************************************************************
//
// The type definition for event functions.
//
//*****************************************************************************
typedef void (* tEventFunction)(uint32_t ui32Event, void* pvData,
                                uint32_t ui32Param);

//*****************************************************************************
//
// Exported Ethernet function prototypes.
//
//*****************************************************************************
extern void EthClientInit(tEventFunction pfnEvent);
extern void EthClientProxySet(const char *pcProxyName);
extern void EthClientTick(uint32_t ui32TickMS);
extern uint32_t EthClientAddrGet(void);
extern void EthClientMACAddrGet(uint8_t *pui8Addr);
extern uint32_t EthClientServerAddrGet(void);
extern void EthClientReset(void);
void EthClientTCPDisconnect(void);

//*****************************************************************************
//
// Exported weather related prototypes.
//
//*****************************************************************************
extern void WeatherSourceSet(tWeatherSource eWeatherSource);
extern int32_t WeatherCurrent(tWeatherSource eWeatherSource,
                              const char *pcQuery,
                              tWeatherReport *psWeather,
                              tEventFunction pfnEvent);
extern int32_t WeatherForecast(tWeatherSource eWeatherSource,
                               const char *pcQuery,
                               tWeatherReport *psWeather,
                               tEventFunction pfnEvent);

#ifdef __cplusplus
}
#endif

#endif