Source code for adafruit_register.i2c_struct

# SPDX-FileCopyrightText: 2016 Scott Shawcroft for Adafruit Industries
#
# SPDX-License-Identifier: MIT
# pylint: disable=too-few-public-methods

"""
`adafruit_register.i2c_struct`
====================================================

Generic structured registers based on `struct`

* Author(s): Scott Shawcroft
"""

import struct

__version__ = "0.0.0-auto.0"
__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_Register.git"


[docs]class Struct: """ Arbitrary structure register that is readable and writeable. Values are tuples that map to the values in the defined struct. See struct module documentation for struct format string and its possible value types. :param int register_address: The register address to read the bit from :param type struct_format: The struct format string for this register. """ def __init__(self, register_address, struct_format): self.format = struct_format self.buffer = bytearray(1 + struct.calcsize(self.format)) self.buffer[0] = register_address def __get__(self, obj, objtype=None): with obj.i2c_device as i2c: i2c.write_then_readinto(self.buffer, self.buffer, out_end=1, in_start=1) return struct.unpack_from(self.format, memoryview(self.buffer)[1:]) def __set__(self, obj, value): struct.pack_into(self.format, self.buffer, 1, *value) with obj.i2c_device as i2c: i2c.write(self.buffer)
[docs]class UnaryStruct: """ Arbitrary single value structure register that is readable and writeable. Values map to the first value in the defined struct. See struct module documentation for struct format string and its possible value types. :param int register_address: The register address to read the bit from :param type struct_format: The struct format string for this register. """ def __init__(self, register_address, struct_format): self.format = struct_format self.address = register_address def __get__(self, obj, objtype=None): buf = bytearray(1 + struct.calcsize(self.format)) buf[0] = self.address with obj.i2c_device as i2c: i2c.write_then_readinto(buf, buf, out_end=1, in_start=1) return struct.unpack_from(self.format, buf, 1)[0] def __set__(self, obj, value): buf = bytearray(1 + struct.calcsize(self.format)) buf[0] = self.address struct.pack_into(self.format, buf, 1, value) with obj.i2c_device as i2c: i2c.write(buf)
[docs]class ROUnaryStruct(UnaryStruct): """ Arbitrary single value structure register that is read-only. Values map to the first value in the defined struct. See struct module documentation for struct format string and its possible value types. :param int register_address: The register address to read the bit from :param type struct_format: The struct format string for this register. """ def __set__(self, obj, value): raise AttributeError()