2 * This file is part of the libsigrok project.
4 * Copyright (C) 2013 Matthias Heidbrink <m-sigrok@heidbrink.biz>
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.
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.
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/>.
21 * Gossen Metrawatt Metrahit 1x/2x drivers
25 #ifndef LIBSIGROK_HARDWARE_GMC_MH_1X_2X_PROTOCOL_H
26 #define LIBSIGROK_HARDWARE_GMC_MH_1X_2X_PROTOCOL_H
30 #include "libsigrok.h"
31 #include "libsigrok-internal.h"
33 #define LOG_PREFIX "gmc-mh-1x-2x"
35 #define GMC_BUFSIZE 266
37 /** Message ID bits 4, 5 */
38 #define MSGID_MASK 0x30 /**< Mask to get message ID bits */
39 #define MSGID_INF 0x00 /**< Start of message with device info */
40 #define MSGID_D10 0x10 /**< Start of data message, non-displayed intermediate */
41 #define MSGID_DTA 0x20 /**< Start of data message, displayed, averaged */
42 #define MSGID_DATA 0x30 /**< Data byte in message */
44 #define MSGC_MASK 0x0f /**< Mask to get message byte contents in send mode */
46 #define MSGSRC_MASK 0xc0 /**< Mask to get bits related to message source */
48 #define bc(x) (x & MSGC_MASK) /**< Get contents from a byte */
50 #define MASK_6BITS 0x3f /**< Mask lower six bits. */
53 * Internal multimeter model codes. In opposite to the multimeter models from
54 * protocol (see decode_model()), these codes allow working with ranges.
57 METRAHIT_NONE = 0, /**< Value for uninitialized variable */
64 METRAHIT_16X = METRAHIT_16I, /**< All Metrahit 16 */
65 /* A Metrahit 17 exists, but seems not to have an IR interface. */
67 METRAHIT_2X = 20, /**< For model type comparisons */
77 /** Get model string from sigrok-internal model code. */
78 SR_PRIV const char *gmc_model_str(enum model mcode);
80 /** Private, per-device-instance driver context. */
82 /* Model-specific information */
83 enum model model; /**< Model code. */
85 /* Acquisition settings */
86 uint64_t limit_samples; /**< Target number of samples */
87 uint64_t limit_msec; /**< Target sampling time */
89 /* Opaque pointer passed in by frontend. */
92 /* Operational state */
93 gboolean settings_ok; /**< Settings msg received yet. */
94 int msg_type; /**< Message type (MSGID_INF, ...). */
95 int msg_len; /**< Message lengh (valid when msg, curr. type known).*/
96 int mq; /**< Measured quantity */
97 int unit; /**< Measured unit */
98 uint64_t mqflags; /**< Measured quantity flags */
99 float value; /**< Measured value */
100 float scale; /**< Scale for value. */
101 int8_t scale1000; /**< Additional scale factor 1000^x. */
102 gboolean vmains_29S; /**< Measured ctmv is V mains (29S only). */
104 /* Temporary state across callbacks */
105 uint64_t num_samples; /**< Current #samples for limit_samples */
106 GTimer *elapsed_msec; /**< Used for sampling with limit_msec */
107 uint8_t buf[GMC_BUFSIZE]; /**< Buffer for read callback */
108 int buflen; /**< Data len in buf */
111 SR_PRIV int gmc_mh_1x_2x_receive_data(int fd, int revents, void *cb_data);
112 SR_PRIV int gmc_decode_model_sm(uint8_t mcode);