ltr390uv

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

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

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

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

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

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

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

126

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

132
    def soft_reset(self):
133
        raise NotImplementedError
134

135

136
class BaseSensorEx(DeviceEx):
137
    """Класс - основа датчика"""
138
    def get_id(self):
139
        raise NotImplementedError
140

141
    def soft_reset(self):
142
        raise NotImplementedError
143

144

145
class Iterator:
146
    def __iter__(self):
147
        return self
148

149
    def __next__(self):
150
        raise NotImplementedError
151

152

153
class TemperatureSensor:
154
    """Вспомогательный или основной датчик температуры"""
155
    def enable_temp_meas(self, enable: bool = True):
156
        """Включает измерение температуры при enable в Истина
157
        Для переопределения программистом!!!"""
158
        raise NotImplementedError
159

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