]> sigrok.org Git - libsigrok.git/blame - src/hardware/korad-kaxxxxp/protocol.h
korad-kaxxxxp: Fix bug when setting values while acquisition is running.
[libsigrok.git] / src / hardware / korad-kaxxxxp / protocol.h
CommitLineData
e75ee7de
HV
1/*
2 * This file is part of the libsigrok project.
3 *
4 * Copyright (C) 2015 Hannu Vuolasaho <vuokkosetae@gmail.com>
3f9b48ae 5 * Copyright (C) 2018 Frank Stettner <frank-stettner@gmx.net>
e75ee7de
HV
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
16fc7ee2
UH
21#ifndef LIBSIGROK_HARDWARE_KORAD_KAXXXXP_PROTOCOL_H
22#define LIBSIGROK_HARDWARE_KORAD_KAXXXXP_PROTOCOL_H
e75ee7de
HV
23
24#include <stdint.h>
d7083042 25#include <string.h>
e75ee7de
HV
26#include <glib.h>
27#include <libsigrok/libsigrok.h>
28#include "libsigrok-internal.h"
29
16fc7ee2 30#define LOG_PREFIX "korad-kaxxxxp"
e75ee7de 31
16fc7ee2 32#define KAXXXXP_POLL_INTERVAL_MS 80
d7083042
HV
33
34enum {
ae9ca5b1
UH
35 VELLEMAN_PS3005D,
36 VELLEMAN_LABPS3005D,
bcf9384d 37 KORAD_KA3005P,
a078d3ec 38 KORAD_KA3005P_0X01,
1c0e1baa 39 KORAD_KA3005P_0XBC,
41802ca4 40 KORAD_KD3005P,
76f712a7 41 KORAD_KD3005P_V20_NOSP,
e843992d 42 RND_320K30PV,
0540954d
UH
43 TENMA_72_2540_V20,
44 TENMA_72_2540_V21,
ddbe6880 45 TENMA_72_2535_V21,
27a9b663 46 STAMOS_SLS31_V20,
b1b8a7d0 47 KORAD_KD6005P,
d7083042
HV
48 /* Support for future devices with this protocol. */
49};
50
51/* Information on single model */
16fc7ee2 52struct korad_kaxxxxp_model {
d7083042 53 int model_id; /**< Model info */
2c240774
UH
54 const char *vendor; /**< Vendor name */
55 const char *name; /**< Model name */
56 const char *id; /**< Model ID, as delivered by interface */
d7083042
HV
57 int channels; /**< Number of channels */
58 double voltage[3]; /**< Min, max, step */
59 double current[3]; /**< Min, max, step */
60};
61
62/* Reply targets */
63enum {
16fc7ee2 64 KAXXXXP_CURRENT,
8da30037 65 KAXXXXP_CURRENT_LIMIT,
16fc7ee2 66 KAXXXXP_VOLTAGE,
8da30037 67 KAXXXXP_VOLTAGE_TARGET,
16fc7ee2
UH
68 KAXXXXP_STATUS,
69 KAXXXXP_OUTPUT,
70 KAXXXXP_BEEP,
71 KAXXXXP_OCP,
72 KAXXXXP_OVP,
73 KAXXXXP_SAVE,
74 KAXXXXP_RECALL,
d7083042
HV
75};
76
e75ee7de 77struct dev_context {
16fc7ee2 78 const struct korad_kaxxxxp_model *model; /**< Model information. */
e75ee7de 79
597deef9 80 struct sr_sw_limits limits;
d7083042 81 int64_t req_sent_at;
3f9b48ae 82 GMutex rw_mutex;
d7083042 83
d7083042 84 float current; /**< Last current value [A] read from device. */
8da30037 85 float current_limit; /**< Output current set. */
d7083042 86 float voltage; /**< Last voltage value [V] read from device. */
8da30037 87 float voltage_target; /**< Output voltage set. */
d7083042 88 gboolean cc_mode[2]; /**< Device is in CC mode (otherwise CV). */
e75ee7de 89
d7083042
HV
90 gboolean output_enabled; /**< Is the output enabled? */
91 gboolean beep_enabled; /**< Enable beeper. */
9e5366df
UH
92 gboolean ocp_enabled; /**< Output current protection enabled. */
93 gboolean ovp_enabled; /**< Output voltage protection enabled. */
e75ee7de 94
3f9b48ae 95 int acquisition_target; /**< What reply to expect. */
d7083042 96 int program; /**< Program to store or recall. */
8da30037
FS
97
98 float set_current_limit; /**< New output current to set. */
99 float set_voltage_target; /**< New output voltage to set. */
100 gboolean set_output_enabled; /**< New output enabled to set. */
101 gboolean set_beep_enabled; /**< New enable beeper to set. */
102 gboolean set_ocp_enabled; /**< New OCP enabled to set. */
103 gboolean set_ovp_enabled; /**< New OVP enabled to set. */
e75ee7de
HV
104};
105
16fc7ee2 106SR_PRIV int korad_kaxxxxp_send_cmd(struct sr_serial_dev_inst *serial,
d7083042 107 const char *cmd);
16fc7ee2 108SR_PRIV int korad_kaxxxxp_read_chars(struct sr_serial_dev_inst *serial,
d7083042 109 int count, char *buf);
16fc7ee2 110SR_PRIV int korad_kaxxxxp_set_value(struct sr_serial_dev_inst *serial,
3f9b48ae
FS
111 int target, struct dev_context *devc);
112SR_PRIV int korad_kaxxxxp_get_value(struct sr_serial_dev_inst *serial,
113 int target, struct dev_context *devc);
16fc7ee2 114SR_PRIV int korad_kaxxxxp_get_all_values(struct sr_serial_dev_inst *serial,
d7083042 115 struct dev_context *devc);
16fc7ee2 116SR_PRIV int korad_kaxxxxp_receive_data(int fd, int revents, void *cb_data);
e75ee7de
HV
117
118#endif