src/hardware/korad-kaxxxxp/protocol.h

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2015 Hannu Vuolasaho <vuokkosetae@gmail.com>
   5  * Copyright (C) 2018-2019 Frank Stettner <frank-stettner@gmx.net>
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation, either version 3 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21 #ifndef LIBSIGROK_HARDWARE_KORAD_KAXXXXP_PROTOCOL_H
  22 #define LIBSIGROK_HARDWARE_KORAD_KAXXXXP_PROTOCOL_H
  23
  24 #include <stdint.h>
  25 #include <string.h>
  26 #include <glib.h>
  27 #include <libsigrok/libsigrok.h>
  28 #include "libsigrok-internal.h"
  29
  30 #define LOG_PREFIX "korad-kaxxxxp"
  31
  32 #define KAXXXXP_POLL_INTERVAL_MS 80
  33
  34 enum {
  35         VELLEMAN_PS3005D,
  36         VELLEMAN_LABPS3005D,
  37         KORAD_KA3005P,
  38         KORAD_KA3005P_0X01,
  39         KORAD_KA3005P_0XBC,
  40         KORAD_KA3005P_V42,
  41         KORAD_KA3005P_V55,
  42         KORAD_KD3005P,
  43         KORAD_KD3005P_V20_NOSP,
  44         RND_320_KD3005P,
  45         RND_320_KA3005P,
  46         RND_320K30PV,
  47         TENMA_72_2550_V2,
  48         TENMA_72_2540_V20,
  49         TENMA_72_2540_V21,
  50         TENMA_72_2540_V52,
  51         TENMA_72_2535_V21,
  52         STAMOS_SLS31_V20,
  53         KORAD_KD6005P,
  54         /* Support for future devices with this protocol. */
  55 };
  56
  57 /* Information on single model */
  58 struct korad_kaxxxxp_model {
  59         int model_id; /**< Model info */
  60         const char *vendor; /**< Vendor name */
  61         const char *name; /**< Model name */
  62         const char *id; /**< Model ID, as delivered by interface */
  63         int channels; /**< Number of channels */
  64         double voltage[3]; /**< Min, max, step */
  65         double current[3]; /**< Min, max, step */
  66 };
  67
  68 /* Reply targets */
  69 enum {
  70         KAXXXXP_CURRENT,
  71         KAXXXXP_CURRENT_LIMIT,
  72         KAXXXXP_VOLTAGE,
  73         KAXXXXP_VOLTAGE_TARGET,
  74         KAXXXXP_STATUS,
  75         KAXXXXP_OUTPUT,
  76         KAXXXXP_BEEP,
  77         KAXXXXP_OCP,
  78         KAXXXXP_OVP,
  79         KAXXXXP_SAVE,
  80         KAXXXXP_RECALL,
  81 };
  82
  83 struct dev_context {
  84         const struct korad_kaxxxxp_model *model; /**< Model information. */
  85
  86         struct sr_sw_limits limits;
  87         int64_t req_sent_at;
  88         GMutex rw_mutex;
  89
  90         float current;          /**< Last current value [A] read from device. */
  91         float current_limit;    /**< Output current set. */
  92         float voltage;          /**< Last voltage value [V] read from device. */
  93         float voltage_target;   /**< Output voltage set. */
  94         gboolean cc_mode[2];    /**< Device is in CC mode (otherwise CV). */
  95
  96         gboolean output_enabled; /**< Is the output enabled? */
  97         gboolean beep_enabled;   /**< Enable beeper. */
  98         gboolean ocp_enabled;    /**< Output current protection enabled. */
  99         gboolean ovp_enabled;    /**< Output voltage protection enabled. */
 100
 101         gboolean cc_mode_1_changed;      /**< CC mode of channel 1 has changed. */
 102         gboolean cc_mode_2_changed;      /**< CC mode of channel 2 has changed. */
 103         gboolean output_enabled_changed; /**< Output enabled state has changed. */
 104         gboolean ocp_enabled_changed;    /**< OCP enabled state has changed. */
 105         gboolean ovp_enabled_changed;    /**< OVP enabled state has changed. */
 106
 107         int acquisition_target;  /**< What reply to expect. */
 108         int program;             /**< Program to store or recall. */
 109
 110         float set_current_limit;     /**< New output current to set. */
 111         float set_voltage_target;    /**< New output voltage to set. */
 112         gboolean set_output_enabled; /**< New output enabled to set. */
 113         gboolean set_beep_enabled;   /**< New enable beeper to set. */
 114         gboolean set_ocp_enabled;    /**< New OCP enabled to set. */
 115         gboolean set_ovp_enabled;    /**< New OVP enabled to set. */
 116 };
 117
 118 SR_PRIV int korad_kaxxxxp_send_cmd(struct sr_serial_dev_inst *serial,
 119                                         const char *cmd);
 120 SR_PRIV int korad_kaxxxxp_read_chars(struct sr_serial_dev_inst *serial,
 121                                         size_t count, char *buf);
 122 SR_PRIV int korad_kaxxxxp_set_value(struct sr_serial_dev_inst *serial,
 123                                         int target, struct dev_context *devc);
 124 SR_PRIV int korad_kaxxxxp_get_value(struct sr_serial_dev_inst *serial,
 125                                         int target, struct dev_context *devc);
 126 SR_PRIV int korad_kaxxxxp_get_all_values(struct sr_serial_dev_inst *serial,
 127                                         struct dev_context *devc);
 128 SR_PRIV int korad_kaxxxxp_receive_data(int fd, int revents, void *cb_data);
 129
 130 #endif