Instrument Neutral Distributed Interface INDI  1.9.5
vantage.cpp
Go to the documentation of this file.
1 /*******************************************************************************
2  Copyright(c) 2015 Jasem Mutlaq. All rights reserved.
3 
4  INDI Davis Vantage Pro/Pro2/Vue Weather Driver
5 
6  This program is free software; you can redistribute it and/or modify it
7  under the terms of the GNU General Public License as published by the Free
8  Software Foundation; either version 2 of the License, or (at your option)
9  any later version.
10 
11  This program is distributed in the hope that it will be useful, but WITHOUT
12  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14  more details.
15 
16  You should have received a copy of the GNU Library General Public License
17  along with this library; see the file COPYING.LIB. If not, write to
18  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19  Boston, MA 02110-1301, USA.
20 
21  The full GNU General Public License is included in this distribution in the
22  file called LICENSE.
23 *******************************************************************************/
24 
25 #include "vantage.h"
26 
27 #include "indicom.h"
29 
30 #include <memory>
31 #include <cstring>
32 #include <termios.h>
33 
34 #define VANTAGE_CMD 8
35 #define VANTAGE_RES 128
36 #define VANTAGE_TIMEOUT 2
37 
38 static uint16_t crc_table[] = {
39  0x0000, 0x1021, 0x2042, 0x3063, 0x4084, 0x50a5, 0x60c6, 0x70e7, 0x8108, 0x9129, 0xa14a, 0xb16b, 0xc18c, 0xd1ad,
40  0xe1ce, 0xf1ef, 0x1231, 0x0210, 0x3273, 0x2252, 0x52b5, 0x4294, 0x72f7, 0x62d6, 0x9339, 0x8318, 0xb37b, 0xa35a,
41  0xd3bd, 0xc39c, 0xf3ff, 0xe3de, 0x2462, 0x3443, 0x0420, 0x1401, 0x64e6, 0x74c7, 0x44a4, 0x5485, 0xa56a, 0xb54b,
42  0x8528, 0x9509, 0xe5ee, 0xf5cf, 0xc5ac, 0xd58d, 0x3653, 0x2672, 0x1611, 0x0630, 0x76d7, 0x66f6, 0x5695, 0x46b4,
43  0xb75b, 0xa77a, 0x9719, 0x8738, 0xf7df, 0xe7fe, 0xd79d, 0xc7bc, 0x48c4, 0x58e5, 0x6886, 0x78a7, 0x0840, 0x1861,
44  0x2802, 0x3823, 0xc9cc, 0xd9ed, 0xe98e, 0xf9af, 0x8948, 0x9969, 0xa90a, 0xb92b, 0x5af5, 0x4ad4, 0x7ab7, 0x6a96,
45  0x1a71, 0x0a50, 0x3a33, 0x2a12, 0xdbfd, 0xcbdc, 0xfbbf, 0xeb9e, 0x9b79, 0x8b58, 0xbb3b, 0xab1a, 0x6ca6, 0x7c87,
46  0x4ce4, 0x5cc5, 0x2c22, 0x3c03, 0x0c60, 0x1c41, 0xedae, 0xfd8f, 0xcdec, 0xddcd, 0xad2a, 0xbd0b, 0x8d68, 0x9d49,
47  0x7e97, 0x6eb6, 0x5ed5, 0x4ef4, 0x3e13, 0x2e32, 0x1e51, 0x0e70, 0xff9f, 0xefbe, 0xdfdd, 0xcffc, 0xbf1b, 0xaf3a,
48  0x9f59, 0x8f78, 0x9188, 0x81a9, 0xb1ca, 0xa1eb, 0xd10c, 0xc12d, 0xf14e, 0xe16f, 0x1080, 0x00a1, 0x30c2, 0x20e3,
49  0x5004, 0x4025, 0x7046, 0x6067, 0x83b9, 0x9398, 0xa3fb, 0xb3da, 0xc33d, 0xd31c, 0xe37f, 0xf35e, 0x02b1, 0x1290,
50  0x22f3, 0x32d2, 0x4235, 0x5214, 0x6277, 0x7256, 0xb5ea, 0xa5cb, 0x95a8, 0x8589, 0xf56e, 0xe54f, 0xd52c, 0xc50d,
51  0x34e2, 0x24c3, 0x14a0, 0x0481, 0x7466, 0x6447, 0x5424, 0x4405, 0xa7db, 0xb7fa, 0x8799, 0x97b8, 0xe75f, 0xf77e,
52  0xc71d, 0xd73c, 0x26d3, 0x36f2, 0x0691, 0x16b0, 0x6657, 0x7676, 0x4615, 0x5634, 0xd94c, 0xc96d, 0xf90e, 0xe92f,
53  0x99c8, 0x89e9, 0xb98a, 0xa9ab, 0x5844, 0x4865, 0x7806, 0x6827, 0x18c0, 0x08e1, 0x3882, 0x28a3, 0xcb7d, 0xdb5c,
54  0xeb3f, 0xfb1e, 0x8bf9, 0x9bd8, 0xabbb, 0xbb9a, 0x4a75, 0x5a54, 0x6a37, 0x7a16, 0x0af1, 0x1ad0, 0x2ab3, 0x3a92,
55  0xfd2e, 0xed0f, 0xdd6c, 0xcd4d, 0xbdaa, 0xad8b, 0x9de8, 0x8dc9, 0x7c26, 0x6c07, 0x5c64, 0x4c45, 0x3ca2, 0x2c83,
56  0x1ce0, 0x0cc1, 0xef1f, 0xff3e, 0xcf5d, 0xdf7c, 0xaf9b, 0xbfba, 0x8fd9, 0x9ff8, 0x6e17, 0x7e36, 0x4e55, 0x5e74,
57  0x2e93, 0x3eb2, 0x0ed1, 0x1ef0,
58 };
59 
60 uint16_t crc16(const void *c_ptr, size_t len)
61 {
62  const uint8_t *c = (uint8_t *)c_ptr;
63  uint16_t crc = 0;
64 
65  while (len--)
66  crc = crc_table[((crc >> 8) ^ *c++)] ^ (crc << 8);
67 
68  return crc;
69 }
70 
71 // We declare an auto pointer to Vantage.
72 std::unique_ptr<Vantage> vantage(new Vantage());
73 
75 {
76  setVersion(1, 0);
77 }
78 
80 {
81  return (const char *)"Vantage";
82 }
83 
85 {
87 
88  addParameter("WEATHER_FORECAST", "Forecast", 0, 0, 15);
89  addParameter("WEATHER_TEMPERATURE", "Temperature (C)", -10, 30, 15);
90  addParameter("WEATHER_BAROMETER", "Barometer (mbar)", 20, 32.5, 15);
91  addParameter("WEATHER_WIND_SPEED", "Wind (kph)", 0, 20, 15);
92  addParameter("WEATHER_WIND_DIRECTION", "Wind Direction", 0, 360, 15);
93  addParameter("WEATHER_HUMIDITY", "Humidity %", 0, 100, 15);
94  addParameter("WEATHER_RAIN_RATE", "Rain (mm/h)", 0, 0, 15);
95  addParameter("WEATHER_SOLAR_RADIATION", "Solar Radiation (w/m^2)", 0, 10000, 15);
96 
97  setCriticalParameter("WEATHER_FORECAST");
98  setCriticalParameter("WEATHER_TEMPERATURE");
99  setCriticalParameter("WEATHER_WIND_SPEED");
100  setCriticalParameter("WEATHER_RAIN_RATE");
101 
102  addDebugControl();
103 
105 
106  return true;
107 }
108 
110 {
111  return ack();
112 }
113 
115 {
116  int nbytes_written = 0, nbytes_read = 0, rc = -1;
117  char errstr[MAXRBUF];
118  char command[VANTAGE_CMD];
119  char response[VANTAGE_RES];
120 
121  if (!wakeup())
122  return IPS_ALERT;
123 
124  strncpy(command, "LOOP 1", VANTAGE_CMD);
125  command[6] = 0;
126 
127  tcflush(PortFD, TCIOFLUSH);
128 
129  LOGF_DEBUG("CMD (%s)", command);
130 
131  command[6] = 0xA;
132 
133  if ((rc = tty_write(PortFD, command, 7, &nbytes_written)) != TTY_OK)
134  {
135  tty_error_msg(rc, errstr, MAXRBUF);
136  LOGF_ERROR("Loop error: %s.", errstr);
137  return IPS_ALERT;
138  }
139 
140  if ((rc = tty_read(PortFD, response, 1, VANTAGE_TIMEOUT, &nbytes_read)) != TTY_OK)
141  {
142  tty_error_msg(rc, errstr, MAXRBUF);
143  LOGF_ERROR("Loop error: %s.", errstr);
144  return IPS_ALERT;
145  }
146 
147  if (response[0] != 0x06)
148  {
149  LOGF_ERROR("Expecting 0x06, received %#X", response[0]);
150  return IPS_ALERT;
151  }
152 
153  if ((rc = tty_read(PortFD, response, 99, VANTAGE_TIMEOUT, &nbytes_read)) != TTY_OK)
154  {
155  tty_error_msg(rc, errstr, MAXRBUF);
156  LOGF_ERROR("Loop error: %s.", errstr);
157  return IPS_ALERT;
158  }
159 
160  uint16_t crc = crc16(response, 99);
161 
162  if (crc != 0)
163  {
164  LOG_ERROR("CRC check failed.");
165  return IPS_ALERT;
166  }
167 
168  uint8_t *loopData = (uint8_t *)response;
169 
170  LOGF_DEBUG("Packet Type (%d)", loopData[4]);
171 
172  uint8_t forecastValue = loopData[89];
173 
174  LOGF_DEBUG("Raw Forecast (%d)", forecastValue);
175 
176  switch (forecastValue)
177  {
178  // Clear
179  case 0x08:
180  LOG_INFO("Forecast: Mostly Clear.");
181  setParameterValue("WEATHER_FORECAST", 0);
182  break;
183 
184  case 0x06:
185  LOG_INFO("Forecast: Partly Cloudy.");
186  setParameterValue("WEATHER_FORECAST", 1);
187  break;
188 
189  case 0x02:
190  LOG_INFO("Forecast: Mostly Cloudy.");
191  setParameterValue("WEATHER_FORECAST", 2);
192  break;
193 
194  case 0x03:
195  LOG_INFO("Forecast: Mostly Cloudy. Rain within 12 hours.");
196  setParameterValue("WEATHER_FORECAST", 2);
197  break;
198 
199  case 0x12:
200  LOG_INFO("Forecast: Mostly Cloudy. Snow within 12 hours.");
201  setParameterValue("WEATHER_FORECAST", 2);
202  break;
203 
204  case 0x13:
205  LOG_INFO("Forecast: Mostly Cloudy. Rain or Snow within 12 hours.");
206  setParameterValue("WEATHER_FORECAST", 2);
207  break;
208 
209  case 0x07:
210  LOG_INFO("Forecast: Partly Cloudy. Rain within 12 hours.");
211  setParameterValue("WEATHER_FORECAST", 1);
212  break;
213 
214  case 0x16:
215  LOG_INFO("Forecast: Partly Cloudy. Snow within 12 hours.");
216  setParameterValue("WEATHER_FORECAST", 1);
217  break;
218 
219  case 0x17:
220  LOG_INFO("Forecast: Partly Cloudy. Rain or Snow within 12 hours.");
221  setParameterValue("WEATHER_FORECAST", 1);
222  break;
223  }
224 
225  // Inside Temperature
226  uint16_t temperatureValue = loopData[10] << 8 | loopData[9];
227 
228  setParameterValue("WEATHER_TEMPERATURE", ((temperatureValue / 10.0) - 32) / 1.8);
229 
230  LOGF_DEBUG("Raw Temperature (%d) [%#4X %#4X]", temperatureValue, loopData[9], loopData[10]);
231 
232  // Inside Humidity
233  uint8_t humidityValue = loopData[11];
234 
235  setParameterValue("WEATHER_HUMIDITY", humidityValue );
236 
237  LOGF_DEBUG("Raw Inside Humidity (%d) [%#X4]", humidityValue, loopData[11]);
238 
239  // Barometer
240  uint16_t barometerValue = loopData[8] << 8 | loopData[7];
241 
242  setParameterValue("WEATHER_BAROMETER", (barometerValue / 1000.0) * 33.8639);
243 
244  LOGF_DEBUG("Raw Barometer (%d) [%#4X %#4X]", barometerValue, loopData[7], loopData[8]);
245 
246  // Wind Speed
247  uint8_t windValue = loopData[14];
248 
249  LOGF_DEBUG("Raw Wind Speed (%d) [%#4X]", windValue, loopData[14]);
250 
251  setParameterValue("WEATHER_WIND_SPEED", windValue / 0.62137);
252 
253  // Wind Direction
254  uint16_t windDir = loopData[17] << 8 | loopData[16];
255 
256  LOGF_DEBUG("Raw Wind Direction (%d) [%#4X,%#4X]", windDir, loopData[16], loopData[17]);
257 
258  setParameterValue("WEATHER_WIND_DIRECTION", windDir);
259 
260  // Rain Rate
261  uint16_t rainRate = loopData[42] << 8 | loopData[41];
262 
263  LOGF_DEBUG("Raw Rain Rate (%d) [%#4X,%#4X]", rainRate, loopData[41], loopData[42]);
264 
265  setParameterValue("WEATHER_RAIN_RATE", rainRate / (100 * 0.039370));
266 
267  // Solar Radiation
268  uint16_t solarRadiation = loopData[45] << 8 | loopData[44];
269 
270  LOGF_DEBUG("Raw Solar Radiation (%d) [%#4X,%#4X]", solarRadiation, loopData[44], loopData[45]);
271 
272  if (solarRadiation == 32767)
273  solarRadiation = 0;
274 
275  setParameterValue("WEATHER_SOLAR_RADIATION", solarRadiation);
276 
277  return IPS_OK;
278 }
279 
280 bool Vantage::wakeup()
281 {
282  int nbytes_written = 0, nbytes_read = 0, rc = -1;
283  char errstr[MAXRBUF];
284  char command[VANTAGE_CMD];
285  char response[VANTAGE_RES];
286 
287  tcflush(PortFD, TCIOFLUSH);
288 
289  command[0] = 0xA;
290 
291  for (int i = 0; i < 3; i++)
292  {
293  LOGF_DEBUG("CMD (%#X)", command[0]);
294 
295  if ((rc = tty_write(PortFD, command, 1, &nbytes_written)) != TTY_OK)
296  {
297  tty_error_msg(rc, errstr, MAXRBUF);
298  LOGF_ERROR("Wakup error: %s.", errstr);
299  return false;
300  }
301 
302  if ((rc = tty_read_section(PortFD, response, 0xD, VANTAGE_TIMEOUT, &nbytes_read)) != TTY_OK)
303  continue;
304  else
305  {
306  if (nbytes_read == 2)
307  {
308  LOG_DEBUG("Console is awake.");
309  return true;
310  }
311  }
312  }
313 
314  return false;
315 }
316 
317 bool Vantage::ack()
318 {
319  int nbytes_written = 0, nbytes_read = 0, rc = -1;
320  char errstr[MAXRBUF];
321  char command[VANTAGE_CMD];
322  char response[VANTAGE_RES];
323 
324  if (!wakeup())
325  return false;
326 
327  command[0] = 'V';
328  command[1] = 'E';
329  command[2] = 'R';
330  command[3] = 0;
331 
332  tcflush(PortFD, TCIOFLUSH);
333 
334  LOGF_DEBUG("CMD (%s)", command);
335 
336  command[3] = 0xA;
337  command[4] = 0;
338 
339  if ((rc = tty_write(PortFD, command, 4, &nbytes_written)) != TTY_OK)
340  {
341  tty_error_msg(rc, errstr, MAXRBUF);
342  LOGF_ERROR("Ack error: %s.", errstr);
343  return false;
344  }
345 
346  if ((rc = tty_read_section(PortFD, response, 0xD, VANTAGE_TIMEOUT, &nbytes_read)) != TTY_OK)
347  {
348  tty_error_msg(rc, errstr, MAXRBUF);
349  LOGF_ERROR("Ack error: %s.", errstr);
350  return false;
351  }
352 
353  if (response[1] != 0xD)
354  {
355  LOGF_ERROR("Expecting 0xD, received %#X", response[1]);
356  return false;
357  }
358 
359  if ((rc = tty_read_section(PortFD, response, 0xD, VANTAGE_TIMEOUT, &nbytes_read)) != TTY_OK)
360  {
361  tty_error_msg(rc, errstr, MAXRBUF);
362  LOGF_ERROR("Ack error: %s.", errstr);
363  return false;
364  }
365 
366  response[nbytes_read - 2] = 0;
367 
368  if (strcmp(response, "OK") != 0)
369  {
370  LOGF_ERROR("Error response: %s", response);
371  return false;
372  }
373 
374  if ((rc = tty_read_section(PortFD, response, 0xD, VANTAGE_TIMEOUT, &nbytes_read)) != TTY_OK)
375  {
376  tty_error_msg(rc, errstr, MAXRBUF);
377  LOGF_ERROR("Ack error: %s.", errstr);
378  return false;
379  }
380 
381  response[nbytes_read - 2] = 0;
382 
383  LOGF_DEBUG("RES (%s)", response);
384 
385  return true;
386 }
INDI::WeatherInterface::setCriticalParameter
bool setCriticalParameter(std::string param)
setCriticalParameter Set parameter that is considered critical to the operation of the observatory....
Definition: indiweatherinterface.cpp:167
IPState
IPState
Property state.
Definition: indiapi.h:158
LOGF_ERROR
#define LOGF_ERROR(fmt,...)
Definition: indilogger.h:80
IPS_OK
@ IPS_OK
Definition: indiapi.h:161
INDI::Weather::initProperties
virtual bool initProperties() override
Initilize properties initial state and value. The child class must implement this function.
Definition: indiweather.cpp:41
indicom.h
Implementations for common driver routines.
IPS_ALERT
@ IPS_ALERT
Definition: indiapi.h:163
INDI::DefaultDevice::setVersion
void setVersion(uint16_t vMajor, uint16_t vMinor)
Set driver version information to be defined in DRIVER_INFO property as vMajor.vMinor.
Definition: defaultdevice.cpp:1219
Vantage::updateWeather
virtual IPState updateWeather() override
updateWeather Update weather conditions from device or service. The function should not change the st...
Definition: vantage.cpp:114
tty_read_section
int tty_read_section(int fd, char *buf, char stop_char, int timeout, int *nbytes_read)
read buffer from terminal with a delimiter
Definition: indicom.c:557
crc16
uint16_t crc16(const void *c_ptr, size_t len)
Definition: vantage.cpp:60
Connection::Serial::B_19200
@ B_19200
Definition: connectionserial.h:82
VANTAGE_TIMEOUT
#define VANTAGE_TIMEOUT
Definition: vantage.cpp:36
LOG_INFO
#define LOG_INFO(txt)
Definition: indilogger.h:74
MAXRBUF
#define MAXRBUF
Definition: indidriver.c:52
tty_error_msg
void tty_error_msg(int err_code, char *err_msg, int err_msg_len)
Retrieve the tty error message.
Definition: indicom.c:1156
vantage
std::unique_ptr< Vantage > vantage(new Vantage())
tty_read
int tty_read(int fd, char *buf, int nbytes, int timeout, int *nbytes_read)
read buffer from terminal
Definition: indicom.c:473
LOGF_DEBUG
#define LOGF_DEBUG(fmt,...)
Definition: indilogger.h:83
Connection::Serial::setDefaultBaudRate
void setDefaultBaudRate(BaudRate newRate)
setDefaultBaudRate Set default baud rate. The default baud rate is 9600 unless otherwise changed by t...
Definition: connectionserial.cpp:381
INDI::Weather::PortFD
int PortFD
Definition: indiweather.h:154
Vantage::Vantage
Vantage()
Definition: vantage.cpp:74
tty_write
int tty_write(int fd, const char *buf, int nbytes, int *nbytes_written)
Writes a buffer to fd.
Definition: indicom.c:415
connectionserial.h
Vantage::getDefaultName
virtual const char * getDefaultName() override
Definition: vantage.cpp:79
LOG_DEBUG
#define LOG_DEBUG(txt)
Definition: indilogger.h:75
LOG_ERROR
#define LOG_ERROR(txt)
Shorter logging macros. In order to use these macros, the function (or method) "getDeviceName()" must...
Definition: indilogger.h:72
INDI::WeatherInterface::addParameter
void addParameter(std::string name, std::string label, double numMinOk, double numMaxOk, double percWarning)
addParameter Add a physical weather measurable parameter to the weather driver. The weather value has...
Definition: indiweatherinterface.cpp:131
INDI::Weather::serialConnection
Connection::Serial * serialConnection
Definition: indiweather.h:151
VANTAGE_RES
#define VANTAGE_RES
Definition: vantage.cpp:35
Vantage
Definition: vantage.h:29
VANTAGE_CMD
#define VANTAGE_CMD
Definition: vantage.cpp:34
Vantage::Handshake
virtual bool Handshake() override
perform handshake with device to check communication
Definition: vantage.cpp:109
Vantage::initProperties
virtual bool initProperties() override
Initilize properties initial state and value. The child class must implement this function.
Definition: vantage.cpp:84
INDI::DefaultDevice::addDebugControl
void addDebugControl()
Add Debug control to the driver.
Definition: defaultdevice.cpp:639
TTY_OK
@ TTY_OK
Definition: indicom.h:94
vantage.h
INDI::WeatherInterface::setParameterValue
void setParameterValue(std::string name, double value)
setParameterValue Update weather parameter value
Definition: indiweatherinterface.cpp:155