mcp3421

1
# micropython
2
# MIT license
3
# Copyright (c) 2022 Roman Shevchik   goctaprog@gmail.com
4
import struct
5
import micropython
6
from sensor_pack_2 import bus_service
7
from machine import Pin
8

9

10
@micropython.native
11
def check_value(value: [int, None], valid_range, error_msg: str) -> [int, None]:
12
    if value is None:
13
        return value
14
    if value not in valid_range:
15
        raise ValueError(error_msg)
16
    return value
17

18

19
def get_error_str(val_name: str, val: int, rng: range) -> str:
20
    """Возвращает подробное сообщение об ошибке.
21
    val_name - имя переменной в коде;
22
    val - значение переменной val_name;
23
    rng - допустимый диапазон переменной"""
24
    return f"Значение {val} параметра {val_name} вне диапазона [{rng.start}..{rng.stop - 1}]!"
25

26

27
def all_none(*args):
28
    """возвращает Истина, если все входные параметры в None.
29
    Добавил 25.01.2024"""
30
    for element in args:
31
        if element is not None:
32
            return False
33
    return True
34

35

36
class Device:
37
    """Класс - основа датчика"""
38

39
    def __init__(self, adapter: bus_service.BusAdapter, address: [int, Pin], big_byte_order: bool):
40
        """Базовый класс Устройство.
41
        Если big_byte_order равен True -> порядок байтов в регистрах устройства «big»
42
        (Порядок от старшего к младшему), в противном случае порядок байтов в регистрах "little"
43
        (Порядок от младшего к старшему)
44
        address - адрес устройства на шине.
45

46
        Base device class. if big_byte_order is True -> register values byteorder is 'big'
47
        else register values byteorder is 'little'
48
        address - address of the device on the bus."""
49
        self.adapter = adapter
50
        self.address = address
51
        # for I2C. byte order in register of device
52
        self.big_byte_order = big_byte_order
53
        # for SPI ONLY. При передаче данных по SPI: SPI.firstbit can be SPI.MSB or SPI.LSB
54
        # передавать первым битом старший или младший
55
        # для каждого устройства!
56
        self.msb_first = True
57

58
    def _get_byteorder_as_str(self) -> tuple:
59
        """Return byteorder as string"""
60
        if self.is_big_byteorder():
61
            return 'big', '>'
62
        return 'little', '<'
63

64
    def pack(self, fmt_char: str, *values) -> bytes:
65
        if not fmt_char:
66
            raise ValueError("Invalid fmt_char parameter!")
67
        bo = self._get_byteorder_as_str()[1]
68
        return struct.pack(bo + fmt_char, values)
69

70
    def unpack(self, fmt_char: str, source: bytes, redefine_byte_order: str = None) -> tuple:
71
        """распаковка массива, считанного из датчика.
72
        Если redefine_byte_order != None, то bo (смотри ниже) = redefine_byte_order
73
        fmt_char: c, b, B, h, H, i, I, l, L, q, Q. pls see: https://docs.python.org/3/library/struct.html"""
74
        if not fmt_char:
75
            raise ValueError("Invalid fmt_char parameter!")
76
        bo = self._get_byteorder_as_str()[1]
77
        if redefine_byte_order is not None:
78
            bo = redefine_byte_order[0]
79
        return struct.unpack(bo + fmt_char, source)
80

81
    @micropython.native
82
    def is_big_byteorder(self) -> bool:
83
        return self.big_byte_order
84

85

86
class DeviceEx(Device):
87
    """Класс - основа датчика. Добавил общие методы доступа к шине. 30.01.2024"""
88

89
    def read_reg(self, reg_addr: int, bytes_count=2) -> bytes:
90
        """считывает из регистра датчика значение.
91
        bytes_count - размер значения в байтах.
92
        Должна быть реализована во всех классах - адаптерах шин, наследников BusAdapter.
93
        Добавил 25.01.2024"""
94
        return self.adapter.read_register(self.address, reg_addr, bytes_count)
95

96
    # BaseSensor
97
    def write_reg(self, reg_addr: int, value: [int, bytes, bytearray], bytes_count) -> int:
98
        """записывает данные value в датчик, по адресу reg_addr.
99
        bytes_count - кол-во записываемых данных.
100
        Добавил 25.01.2024"""
101
        byte_order = self._get_byteorder_as_str()[0]
102
        return self.adapter.write_register(self.address, reg_addr, value, bytes_count, byte_order)
103

104
    def read(self, n_bytes: int) -> bytes:
105
        """Читает из устройства n_bytes байт. Добавил 25.01.2024"""
106
        return self.adapter.read(self.address, n_bytes)
107

108
    def read_to_buf(self, buf) -> bytes:
109
        """Чтение из устройства в буфер"""
110
        return self.adapter.read_to_buf(self.address, buf)
111

112
    def write(self, buf: bytes):
113
        """Записывает в устройство информацию из buf. Добавил 25.01.2024"""
114
        return self.adapter.write(self.address, buf)
115

116
    def read_buf_from_mem(self, address: int, buf, address_size: int = 1):
117
        """Читает из устройства, начиная с адреса address в буфер.
118
        Кол-во читаемых байт равно "длине" буфера в байтах!
119
        address_size - определяет размер адреса в байтах."""
120
        return self.adapter.read_buf_from_memory(self.address, address, buf, address_size)
121

122
    def write_buf_to_mem(self, mem_addr, buf):
123
        """Записывает в устройство все байты из буфера buf.
124
        Запись начинается с адреса в устройстве: mem_addr."""
125
        return self.adapter.write_buf_to_memory(self.address, mem_addr, buf)
126

127

128
class BaseSensor(Device):
129
    """Класс - основа датчика с дополнительными методами"""
130

131
    def get_id(self):
132
        raise NotImplementedError
133

134
    def soft_reset(self):
135
        raise NotImplementedError
136

137

138
class BaseSensorEx(DeviceEx):
139
    """Класс - основа датчика"""
140

141
    def get_id(self):
142
        raise NotImplementedError
143

144
    def soft_reset(self):
145
        raise NotImplementedError
146

147

148
class Iterator:
149
    def __iter__(self):
150
        return self
151

152
    def __next__(self):
153
        raise NotImplementedError
154

155

156
class ITemperatureSensor:
157
    """Вспомогательный или основной датчик температуры"""
158

159
    def enable_temp_meas(self, enable: bool = True):
160
        """Включает измерение температуры при enable в Истина
161
        Для переопределения программистом!!!"""
162
        raise NotImplementedError
163

164
    def get_temperature(self) -> [int, float]:
165
        """Возвращает температуру корпуса датчика в градусах Цельсия!
166
        Для переопределения программистом!!!"""
167
        raise NotImplementedError
168

169

170
# 0 - устройство выполняет все свои функции (максимальное энергопотребление)
171
# maximum (на ваш выбор) - устройство выполняет минимум своих функций (минимальное энергопотребление)
172
#
173
class IPower:
174
    """интерфейс управления мощностью потребления устройства"""
175

176
    def set_power_level(self, level: [int, None] = 0) -> int:
177
        """level >=0 or None
178
        Устанавливает режим мощности.
179
        level равен 0 - устройство выполняет все свои функции (максимальное энергопотребление)
180
        level равен maximum (на ваш выбор) - устройство выполняет минимум своих функций (минимальное энергопотребление)
181
        Возвращает текущий уровень потребления устройства.
182
        Если level в None, то метод должен возвратить текущий уровень потребления устройства!
183
        Если значение из регистра устройства не совпадет со шкалой 0-все включено...максимум-все выключено, то
184
        преобразуйте его!
185
        """
186
        raise NotImplemented
187

188
#    def power_on(self, on: bool = True) -> int:
189
#        """Полностью включает (on в Истина), либо полностью ВЫключает (on в Ложь)
190
#        Возвращает текущий режим потребления устройства."""
191
#        raise NotImplemented
192

193

194
class IBaseSensorEx:
195
    """интерфейсы, обязательные для большинства датчиков"""
196

197
    def get_conversion_cycle_time(self) -> int:
198
        """Возвращает время в мс или мкс преобразования сигнала в цифровой код и готовности его для чтения по шине!
199
        Для текущих настроек датчика. При изменении настроек следует заново вызвать этот метод!"""
200
        raise NotImplemented
201

202
    def start_measurement(self):
203
        """Настраивает параметры датчика и запускает процесс измерения"""
204
        raise NotImplemented
205

206
    def get_measurement_value(self):
207
        """Возвращает измеренное датчиком значение(значения)"""
208
        raise NotImplemented
209

210
#    def is_data_ready(self) -> bool:
211
#        """Возвращает Истина, если данные доступны для считывания"""
212
#        raise NotImplemented
213

214
    def is_single_shot_mode(self) -> bool:
215
        """Возвращает Истина, когда датчик находится в режиме однократных измерений,
216
        каждое из которых запускается методом start_measurement"""
217
        raise NotImplemented
218

219
    def is_continuously_mode(self) -> bool:
220
        """Возвращает Истина, когда датчик находится в режиме многократных измерений,
221
        производимых автоматически. Процесс запускается методом start_measurement"""
222
        raise NotImplemented
223