Add miniscale unit

Author: icyqwq

m5stack/libs/unit/__init__.py

@@ -39,6 +39,7 @@
     "LoRaE220JPUnit": "lora_e220_jp",
     "WEIGHTUnit": "weight",
     "SCALESUnit": "scales",
+    "MiniScale": "miniscale",
 }
 
 

m5stack/libs/unit/miniscale.py

@@ -0,0 +1,140 @@
+# -*- encoding: utf-8 -*-
+'''
+@File    :   _miniscale.py
+@Time    :   2023/12/19
+@Author  :   TONG YIHAN
+@E-mail  :   [email protected]
+@License :   (C)Copyright 2015-2023, M5STACK
+@Desc    :   This sensor is capable of measuring weight and also includes additional functionalities like LED control and various filters.
+'''
+
+# Import necessary libraries
+from machine import I2C
+from .pahub import PAHUBUnit
+from .unit_helper import UnitError
+import time
+import struct
+try:
+    from typing import Union
+except ImportError:
+    pass
+
+class Miniscale:
+    """! MiniScale is a weight sensor, includes a hx711 22bit ADC.
+    
+    """
+	def __init__(self, i2c: Union[I2C, PAHUBUnit], addr=0x26):
+        self.i2c = i2c
+        self.addr = addr
+        self._available()
+
+    def _available(self):
+        """! Check if sensor is available on the I2C bus.
+        
+        Raises:
+            UnitError: If the sensor is not found.
+        """
+        if not (self.i2c_addr in self.i2c.scan()):
+            raise UnitError("MiniScale Unit not found.")
+        
+    @property
+    def adc(self) -> int:
+        """! Get the ADC value."""
+        data = self.i2c.readfrom_mem(self.addr, 0x00, 4)
+        return struct.unpack('<I', data)[0]
+    
+    @property
+    def weight(self) -> float:
+        """! Get the weight in grams."""
+        data = self.i2c.readfrom_mem(self.addr, 0x10, 4)
+        return struct.unpack('<f', data)[0]
+    
+    @property
+    def button(self) -> bool:
+        """! Get the button state."""
+        data = self.i2c.readfrom_mem(self.addr, 0x20, 1)
+        return struct.unpack('b', data)[0] == 0
+    
+    def setLed(self, r: int, g: int, b: int):
+        """! Set the RGB LED color.
+
+        @param r Red value. 0 - 255
+        @param g Green value. 0 - 255
+        @param b Blue value. 0 - 255
+        """
+        self.i2c.writeto_mem(self.addr, 0x30, bytes([r, g, b]))
+
+    def reset(self):
+        """! Reset weight value to zero
+        
+        """
+        self.i2c.writeto_mem(self.addr, 0x50, b'\x01')
+
+    def calibration(self, weight1_g: float, weight1_adc: int, weight2_g: float, weight2_adc: int):
+        """! Calibration the MiniScale sensor.
+
+        (1) step 1:  Reset offset;
+        (2) step 2: Get RawADC, this is RawADC_0g
+        (3) step 3: Put 100g weight on it, and get RawADC, this is RawADC_100g
+        (4) step 4: Calculate the value of GAP = (RawADC_100g-RawADC0g) / 100
+        (5) step 5:  Write GAP value to the unit Via I2C
+        
+        @param weight1_g Weight1 in grams.
+        @param weight1_adc Weight1 in ADC.
+        @param weight2_g Weight2 in grams.
+        @param weight2_adc Weight2 in ADC.
+        """
+        
+        gap = (weight2_adc - weight1_adc) / (weight2_g - weight1_g)
+        self.i2c.writeto_mem(self.addr, 0x40, struct.pack('<f', gap))
+
+    def setLowPassFilter(self, enabled: bool):
+        """! Set low pass filter enabled or not
+        
+        @param enabled Enable filter or not
+        """
+        if enabled:
+            self.i2c.writeto_mem(self.addr, 0x80, b'\x01')
+        else:
+            self.i2c.writeto_mem(self.addr, 0x80, b'\x00')
+
+    def getLowPassFilter(self) -> bool:
+        """! Get low pass filter enabled or not
+        
+        """
+        data = self.i2c.readfrom_mem(self.addr, 0x80, 1)
+        return data == b'\x01'
+
+    def setAverageFilterLevel(self, level: int):
+        """! Set average filter level
+        
+        @param level level of average filter, larger value for smoother result but more latency
+        """
+        if level > 50 or level < 0:
+            raise Exception("Level for average filter must between 0 ~ 50")
+
+        self.i2c.writeto_mem(self.addr, 0x81, struct.pack('b', level))
+    
+    def getAverageFilterLevel(self) -> int:
+        """! Get average filter level
+        
+        """
+        data = self.i2c.readfrom_mem(self.addr, 0x81, 1)
+        return struct.unpack('b', data)[0]
+
+    def setEMAFilterAlpha(self, alpha: int):
+        """! Set ema filter alpha
+        
+        @param alpha alpha of ema filter, smaller value for smoother result but more latency
+        """
+        if alpha > 99 or alpha < 0:
+            raise Exception("Alpha for EMA filter must between 0 ~ 99")
+
+        self.i2c.writeto_mem(self.addr, 0x82, struct.pack('b', alpha))
+
+    def getEMAFilterAlpha(self) -> int:
+        """! Get ema filter alpha
+
+        """
+        data = self.i2c.readfrom_mem(self.addr, 0x82, 1)
+        return struct.unpack('b', data)[0]

m5stack/test/test.py

@@ -0,0 +1,52 @@
+import os, sys, io
+import M5
+from M5 import *
+from unit import *
+
+label0 = None
+label1 = None
+lorae220_0 = None
+
+
+lorae220_rssi = None
+lorae220_data = None
+
+
+def lorae220_0_receive_event(received_data, rssi):
+  global label0, label1, lorae220_0, lorae220_rssi, lorae220_data
+  _ = received_data
+  lorae220_rssi = rssi
+  print(received_data)
+  label0.setText(received_data.decode('ascii'))
+
+
+def setup():
+  global label0, label1, lorae220_0, lorae220_rssi, lorae220_data
+
+  lorae220_0 = LoRaE220JPUnit((33, 32))
+  M5.begin()
+  Widgets.fillScreen(0x222222)
+  label0 = Widgets.Label("label0", 37, 43, 1.0, 0xffffff, 0x222222, Widgets.FONTS.DejaVu18)
+  label1 = Widgets.Label("label1", 37, 130, 1.0, 0xffffff, 0x222222, Widgets.FONTS.DejaVu18)
+
+  lorae220_0.setup(0x0000, 0, 0x2333)
+  lorae220_0.receiveNoneBlock(lorae220_0_receive_event)
+
+
+def loop():
+  global label0, label1, lorae220_0, lorae220_rssi, lorae220_data
+  M5.update()
+  lorae220_0.send(0x0000, 0, 'Hello???')
+
+
+if __name__ == '__main__':
+  try:
+    setup()
+    while True:
+      loop()
+  except (Exception, KeyboardInterrupt) as e:
+    try:
+      from utility import print_error_msg
+      print_error_msg(e)
+    except ImportError:
+      print("please update to latest firmware")

m5stack/test/test2.py

@@ -0,0 +1,54 @@
+import os, sys, io
+import M5
+from M5 import *
+import time
+from unit import *
+
+
+label0 = None
+label1 = None
+lorae220_0 = None
+
+
+lorae220_rssi = None
+lorae220_data = None
+
+
+def lorae220_0_receive_event(received_data, rssi):
+  global label0, label1, lorae220_0, lorae220_rssi, lorae220_data
+  lorae220_data = received_data
+  lorae220_rssi = rssi
+  label0.setText(str(lorae220_data.decode()))
+
+
+def setup():
+  global label0, label1, lorae220_0, lorae220_rssi, lorae220_data
+
+  lorae220_0 = LoRaE220JPUnit((33, 32))
+  M5.begin()
+  Widgets.fillScreen(0x222222)
+  label0 = Widgets.Label("label0", 37, 43, 1.0, 0xffffff, 0x222222, Widgets.FONTS.DejaVu18)
+  label1 = Widgets.Label("label1", 37, 130, 1.0, 0xffffff, 0x222222, Widgets.FONTS.DejaVu18)
+
+  lorae220_0.setup(0x0000, 0, 0x2333)
+  lorae220_0.receiveNoneBlock(lorae220_0_receive_event)
+
+
+def loop():
+  global label0, label1, lorae220_0, lorae220_rssi, lorae220_data
+  M5.update()
+  lorae220_0.send(0x0000, 0, 'Hello???555')
+  time.sleep(2)
+
+
+if __name__ == '__main__':
+  try:
+    setup()
+    while True:
+      loop()
+  except (Exception, KeyboardInterrupt) as e:
+    try:
+      from utility import print_error_msg
+      print_error_msg(e)
+    except ImportError:
+      print("please update to latest firmware")