src/hardware/teleinfo/protocol.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2013 Aurelien Jacobs <aurel@gnuage.org>
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #include <stdlib.h>
  21 #include <string.h>
  22 #include <glib.h>
  23 #include "protocol.h"
  24
  25 #define STX  0x02
  26 #define ETX  0x03
  27 #define EOT  0x04
  28 #define LF   0x0A
  29 #define CR   0x0D
  30
  31 static gboolean teleinfo_control_check(char *label, char *data, char control)
  32 {
  33         int sum = 0;
  34         while (*label)
  35                 sum += *label++;
  36         sum += ' ';
  37         while (*data)
  38                 sum += *data++;
  39         return ((sum & 0x3F) + ' ') == control;
  40 }
  41
  42 static gint teleinfo_channel_compare(gconstpointer a, gconstpointer b)
  43 {
  44         const struct sr_channel *ch = a;
  45         const char *name = b;
  46         return strcmp(ch->name, name);
  47 }
  48
  49 static struct sr_channel *teleinfo_find_channel(struct sr_dev_inst *sdi,
  50                                             const char *name)
  51 {
  52         GSList *elem = g_slist_find_custom(sdi->channels, name,
  53                                            teleinfo_channel_compare);
  54         return elem ? elem->data : NULL;
  55 }
  56
  57 static void teleinfo_send_value(struct sr_dev_inst *sdi, const char *channel_name,
  58                                 float value, int mq, int unit)
  59 {
  60         struct dev_context *devc;
  61         struct sr_datafeed_packet packet;
  62         struct sr_datafeed_analog analog;
  63         struct sr_channel *ch;
  64
  65         devc = sdi->priv;
  66         ch = teleinfo_find_channel(sdi, channel_name);
  67
  68         if (!ch || !ch->enabled)
  69                 return;
  70
  71         memset(&analog, 0, sizeof(struct sr_datafeed_analog));
  72         analog.channels = g_slist_append(analog.channels, ch);
  73         analog.num_samples = 1;
  74         analog.mq = mq;
  75         analog.unit = unit;
  76         analog.data = &value;
  77
  78         packet.type = SR_DF_ANALOG;
  79         packet.payload = &analog;
  80         sr_session_send(devc->session_cb_data, &packet);
  81         g_slist_free(analog.channels);
  82 }
  83
  84 static void teleinfo_handle_mesurement(struct sr_dev_inst *sdi,
  85                                        const char *label, const char *data,
  86                                        char *optarif)
  87 {
  88         struct dev_context *devc;
  89         int v = atoi(data);
  90
  91         if (!sdi || !(devc = sdi->priv)) {
  92                 if (optarif && !strcmp(label, "OPTARIF"))
  93                         strcpy(optarif, data);
  94                 return;
  95         }
  96
  97         if (!strcmp(label, "ADCO")) {
  98                 devc->num_samples++;
  99         } else if (!strcmp(label, "BASE")) {
 100                 teleinfo_send_value(sdi, "BASE", v, SR_MQ_POWER, SR_UNIT_WATT_HOUR);
 101         } else if (!strcmp(label, "HCHP")) {
 102                 teleinfo_send_value(sdi, "HP"  , v, SR_MQ_POWER, SR_UNIT_WATT_HOUR);
 103         } else if (!strcmp(label, "HCHC")) {
 104                 teleinfo_send_value(sdi, "HC"  , v, SR_MQ_POWER, SR_UNIT_WATT_HOUR);
 105         } else if (!strcmp(label, "EJPHN")) {
 106                 teleinfo_send_value(sdi, "HN"  , v, SR_MQ_POWER, SR_UNIT_WATT_HOUR);
 107         } else if (!strcmp(label, "EJPHPM")) {
 108                 teleinfo_send_value(sdi, "HPM" , v, SR_MQ_POWER, SR_UNIT_WATT_HOUR);
 109         } else if (!strcmp(label, "BBRHPJB")) {
 110                 teleinfo_send_value(sdi, "HPJB", v, SR_MQ_POWER, SR_UNIT_WATT_HOUR);
 111         } else if (!strcmp(label, "BBRHPJW")) {
 112                 teleinfo_send_value(sdi, "HPJW", v, SR_MQ_POWER, SR_UNIT_WATT_HOUR);
 113         } else if (!strcmp(label, "BBRHPJR")) {
 114                 teleinfo_send_value(sdi, "HPJR", v, SR_MQ_POWER, SR_UNIT_WATT_HOUR);
 115         } else if (!strcmp(label, "BBRHCJB")) {
 116                 teleinfo_send_value(sdi, "HCJB", v, SR_MQ_POWER, SR_UNIT_WATT_HOUR);
 117         } else if (!strcmp(label, "BBRHCJW")) {
 118                 teleinfo_send_value(sdi, "HCJW", v, SR_MQ_POWER, SR_UNIT_WATT_HOUR);
 119         } else if (!strcmp(label, "BBRHCJR")) {
 120                 teleinfo_send_value(sdi, "HCJR", v, SR_MQ_POWER, SR_UNIT_WATT_HOUR);
 121         } else if (!strcmp(label, "IINST")) {
 122                 teleinfo_send_value(sdi, "IINST", v, SR_MQ_CURRENT, SR_UNIT_AMPERE);
 123         } else if (!strcmp(label, "PAPP")) {
 124                 teleinfo_send_value(sdi, "PAPP", v, SR_MQ_POWER, SR_UNIT_VOLT_AMPERE);
 125         }
 126 }
 127
 128 static gboolean teleinfo_parse_group(struct sr_dev_inst *sdi,
 129                                      const uint8_t *group, char *optarif)
 130 {
 131         char label[9], data[13], control, cr;
 132         const char *str = (const char *)group;
 133         if (sscanf(str, "\x0A%8s %13s %c%c", label, data, &control, &cr) != 4
 134             || cr != CR)
 135                 return FALSE;
 136         if (!teleinfo_control_check(label, data, control))
 137                 return FALSE;
 138         teleinfo_handle_mesurement(sdi, label, data, optarif);
 139         return TRUE;
 140 }
 141
 142 static const uint8_t *teleinfo_parse_data(struct sr_dev_inst *sdi,
 143                                           const uint8_t *buf, int len,
 144                                           char *optarif)
 145 {
 146         const uint8_t *group_start, *group_end;
 147
 148         group_start = memchr(buf, LF, len);
 149         if (!group_start)
 150                 return NULL;
 151
 152         group_end = memchr(group_start, CR, len - (group_start - buf));
 153         if (!group_end)
 154                 return NULL;
 155
 156         teleinfo_parse_group(sdi, group_start, optarif);
 157         return group_end + 1;
 158 }
 159
 160 SR_PRIV int teleinfo_get_optarif(const uint8_t *buf)
 161 {
 162         const uint8_t *ptr = buf;
 163         char optarif[5] = { 0 };
 164
 165         while ((ptr = teleinfo_parse_data(NULL, ptr, 292-(ptr-buf), optarif)));
 166         if (!strcmp(optarif, "BASE"))
 167                 return OPTARIF_BASE;
 168         else if (!strcmp(optarif, "HC.."))
 169                 return OPTARIF_HC;
 170         else if (!strcmp(optarif, "EJP."))
 171                 return OPTARIF_EJP;
 172         else if (!strncmp(optarif, "BBR", 3))
 173                 return OPTARIF_BBR;
 174         return OPTARIF_NONE;
 175 }
 176
 177 SR_PRIV gboolean teleinfo_packet_valid(const uint8_t *buf)
 178 {
 179         return !!teleinfo_get_optarif(buf);
 180 }
 181
 182 SR_PRIV int teleinfo_receive_data(int fd, int revents, void *cb_data)
 183 {
 184         struct sr_dev_inst *sdi;
 185         struct dev_context *devc;
 186         struct sr_serial_dev_inst *serial;
 187         const uint8_t *ptr, *next_ptr, *end_ptr;
 188         int len;
 189         int64_t time;
 190
 191         (void)fd;
 192
 193         if (!(sdi = cb_data) || !(devc = sdi->priv) || revents != G_IO_IN)
 194                 return TRUE;
 195         serial = sdi->conn;
 196
 197         /* Try to get as much data as the buffer can hold. */
 198         len = TELEINFO_BUF_SIZE - devc->buf_len;
 199         len = serial_read(serial, devc->buf + devc->buf_len, len);
 200         if (len < 1) {
 201                 sr_err("Serial port read error: %d.", len);
 202                 return FALSE;
 203         }
 204         devc->buf_len += len;
 205
 206         /* Now look for packets in that data. */
 207         ptr = devc->buf;
 208         end_ptr = ptr + devc->buf_len;
 209         while ((next_ptr = teleinfo_parse_data(sdi, ptr, end_ptr - ptr, NULL)))
 210                 ptr = next_ptr;
 211
 212         /* If we have any data left, move it to the beginning of our buffer. */
 213         memmove(devc->buf, ptr, end_ptr - ptr);
 214         devc->buf_len -= ptr - devc->buf;
 215
 216         /* If buffer is full and no valid packet was found, wipe buffer. */
 217         if (devc->buf_len >= TELEINFO_BUF_SIZE) {
 218                 devc->buf_len = 0;
 219                 return FALSE;
 220         }
 221
 222         if (devc->limit_samples && devc->num_samples >= devc->limit_samples) {
 223                 sr_info("Requested number of samples reached.");
 224                 sdi->driver->dev_acquisition_stop(sdi, devc->session_cb_data);
 225                 return TRUE;
 226         }
 227
 228         if (devc->limit_msec) {
 229                 time = (g_get_monotonic_time() - devc->start_time) / 1000;
 230                 if (time > (int64_t)devc->limit_msec) {
 231                         sr_info("Requested time limit reached.");
 232                         sdi->driver->dev_acquisition_stop(sdi, devc->session_cb_data);
 233                         return TRUE;
 234                 }
 235         }
 236         return TRUE;
 237 }