JoyPi-Advanced-RaspberryPi 2.0.0__tar.gz → 2.0.2__tar.gz

joypi_advanced_raspberrypi-2.0.2/.gitignore

@@ -0,0 +1,2 @@
+/dist/*
+.gitignore

{joypi_advanced_raspberrypi-2.0.0 → joypi_advanced_raspberrypi-2.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: JoyPi_Advanced_RaspberryPi
-Version: 2.0.0
+Version: 2.0.2
 Summary: This library enables usage of some sensors and actors of the Joy-Pi Advanced on the Raspberry Pi.
 Project-URL: Homepage, https://github.com/joy-it/JoyPi_Advanced_RaspberryPi
 Project-URL: Issues, https://github.com/joy-it/JoyPi_Advanced_RaspberryPi/issues
@@ -15,6 +15,7 @@ Description-Content-Type: text/markdown
 This library is a collection for the Raspberry Pi for several modules on the Joy-Pi Advanced. See [here](https://www.joy-pi.net) for more information.
 
 ## Included modules
+
 This library includes the following modules:
 - ADC
 - Gyroscope
@@ -25,9 +26,6 @@ This library includes the following modules:
 - Servo Motor
 - Stepper Motor
 
-> [!WARNING]
-> The Joy-Pi Advanced 2 is no longer compatible with this library for the LED Matrix. To ensure compatibility with the Raspberry Pi 5, the LED matrix is now controlled via I²C because of the RP2040 microcontroller chip. The LED matrix can now be controlled with the Joy-Pi Advanced via [this repository](http://github.com/joy-it/JoyPi_RGB_Matrix_RaspberryPi).
-
 ## Dependencies
 This library has some dependencies which are used to control the modules of the Joy Pi Advanced. To use this library, you will need to install the following dependencies:
 
@@ -36,8 +34,8 @@ This library has some dependencies which are used to control the modules of the
 - [`Adafruit_CircuitPython_MCP230xx`](https://github.com/adafruit/Adafruit_CircuitPython_MCP230xx) - for the button matrix - with `pip install adafruit-circuitpython-mcp230xx` 
 
 ## Installation
-```
-pip install JoyPi_Advanced_RaspberryPi
+```bash
+pip install JoyPi-Advanced-RaspberryPi
 ```
 ## Library Guide
 ### ADC

{joypi_advanced_raspberrypi-2.0.0 → joypi_advanced_raspberrypi-2.0.2}/README.md

@@ -2,6 +2,7 @@
 This library is a collection for the Raspberry Pi for several modules on the Joy-Pi Advanced. See [here](https://www.joy-pi.net) for more information.
 
 ## Included modules
+
 This library includes the following modules:
 - ADC
 - Gyroscope
@@ -12,9 +13,6 @@ This library includes the following modules:
 - Servo Motor
 - Stepper Motor
 
-> [!WARNING]
-> The Joy-Pi Advanced 2 is no longer compatible with this library for the LED Matrix. To ensure compatibility with the Raspberry Pi 5, the LED matrix is now controlled via I²C because of the RP2040 microcontroller chip. The LED matrix can now be controlled with the Joy-Pi Advanced via [this repository](http://github.com/joy-it/JoyPi_RGB_Matrix_RaspberryPi).
-
 ## Dependencies
 This library has some dependencies which are used to control the modules of the Joy Pi Advanced. To use this library, you will need to install the following dependencies:
 
@@ -23,8 +21,8 @@ This library has some dependencies which are used to control the modules of the
 - [`Adafruit_CircuitPython_MCP230xx`](https://github.com/adafruit/Adafruit_CircuitPython_MCP230xx) - for the button matrix - with `pip install adafruit-circuitpython-mcp230xx` 
 
 ## Installation
-```
-pip install JoyPi_Advanced_RaspberryPi
+```bash
+pip install JoyPi-Advanced-RaspberryPi
 ```
 ## Library Guide
 ### ADC

{joypi_advanced_raspberrypi-2.0.0 → joypi_advanced_raspberrypi-2.0.2}/examples/colour.py

@@ -2,14 +2,18 @@
 # Required modules are inserted and configured
 import time
 from JoyPi_Advanced_RaspberryPi import colour
+import busio
+import board
 
+# Create I2C bus.
+i2c = busio.I2C(board.SCL, board.SDA)
 # Create object sensor to control colour sensor
-sensor = colour()
+colour_sensor = colour(i2c, colour.INTEGRATION_TIME_160MS)
 
 # set integration time
-sensor.setIntegrationTime(2)
+colour_sensor.setIntegrationTime(colour.INTEGRATION_TIME_160MS)
 # set senor to auti�Mode
-sensor.autoMode()
+colour_sensor.autoMode()
 # initialize variable to save last printed colour
 last_colour = ""
 
@@ -17,7 +21,7 @@ last_colour = ""
 try:
     while True:
         # get dominant colour and raw values
-        colour, raw_values = sensor.readAll()
+        colour, raw_values = colour_sensor.readAll()
         # check if a new colour is detected
         if last_colour != colour:
             # print colour and raw values
@@ -26,4 +30,4 @@ try:
             last_colour = colour
 except:
     # deactivate colour sensor
-    sensor.disableSensor()
+    colour_sensor.disableSensor()

{joypi_advanced_raspberrypi-2.0.0 → joypi_advanced_raspberrypi-2.0.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "JoyPi_Advanced_RaspberryPi"
-version = "2.0.0"
+version = "2.0.2"
 authors = [
   { name="Joy-IT", email="service@joy-it.net" },
 ]

{joypi_advanced_raspberrypi-2.0.0 → joypi_advanced_raspberrypi-2.0.2}/src/JoyPi_Advanced_RaspberryPi/LEDMatrix.py

@@ -1,15 +1,8 @@
 import time
 from rpi_ws281x import PixelStrip, Color
 
-
 class LEDMatrix:
-    """
-    The Joy-Pi Advanced 2 is no longer compatible with this library for the LED 
-    matrix. To ensure compatibility with the Raspberry Pi 5, the LED matrix is now 
-    controlled via I²C because of the RP2040 microcontroller chip. The LED matrix 
-    can now be controlled with the Joy-Pi Advanced via this repository
-    http://github.com/joy-it/JoyPi_RGB_Matrix_RaspberryPi
-    """
+
     def __init__(self, pin = 18, brightness = 100):
         # LED strip configuration
         self.LED_COUNT = 64              # Number of pixels

joypi_advanced_raspberrypi-2.0.2/src/JoyPi_Advanced_RaspberryPi/colour.py

@@ -0,0 +1,232 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#  
+###################################################################################
+# Edited by Joy-IT
+# 
+###################################################################################
+#  Copyright 2020  <pi@kb>
+#  
+#  This program is free software; you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation; either version 2 of the License, or
+#  (at your option) any later version.
+#  
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#  
+#  You should have received a copy of the GNU General Public License
+#  along with this program; if not, write to the Free Software
+#  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+#  MA 02110-1301, USA.
+#  
+#  Written by BitHead (Britany Head)
+#  https://forums.raspberrypi.com/viewtopic.php?t=263498
+# Step 1) Enable I2C in Raspi-Config (Interfacing Options)
+# Step 2) sudo apt-get install i2c-tools python3-smbus
+# Step 3) plug it in (don't forget your pull-up resistors) and run this program
+
+import busio
+from adafruit_bus_device import i2c_device
+import time
+import threading
+import numpy as np
+
+class colour:
+
+    REG_CONF = 0x00
+    REG_RED = 0x08
+    REG_GREEN = 0x09
+    REG_BLUE = 0x0A
+    REG_WHITE = 0x0B
+
+    INTEGRATION_TIME_40MS = 0
+    INTEGRATION_TIME_80MS = 1
+    INTEGRATION_TIME_160MS = 2
+    INTEGRATION_TIME_320MS = 3
+    INTEGRATION_TIME_640MS = 4
+    INTEGRATION_TIME_1280MS = 5
+
+    _INTEGRATION_TIME_VALUES = {
+        INTEGRATION_TIME_40MS: 0x00,
+        INTEGRATION_TIME_80MS: 0x10,
+        INTEGRATION_TIME_160MS: 0x20,
+        INTEGRATION_TIME_320MS: 0x30,
+        INTEGRATION_TIME_640MS: 0x40,
+        INTEGRATION_TIME_1280MS: 0x50,
+    }
+
+    _INTEGRATION_TIME_DELAY = {
+        INTEGRATION_TIME_40MS: 0.05,
+        INTEGRATION_TIME_80MS: 0.09,
+        INTEGRATION_TIME_160MS: 0.17,
+        INTEGRATION_TIME_320MS: 0.33,
+        INTEGRATION_TIME_640MS: 0.65,
+        INTEGRATION_TIME_1280MS: 1.29,
+    }
+
+    BIT_SD = 0x01
+    BIT_AF = 0x02
+    BIT_TRIG = 0x04
+    MASK_INTEGRATION_TIME = 0x70
+
+    def __init__(self,  i2c: busio.I2C, integration_time=INTEGRATION_TIME_160MS, i2c_address = 0x10):
+        """
+        initialize colour sensor
+        i2c_address - i2c_address of colour sensor (default 0x10)
+        """
+        self.address = i2c_address
+        if integration_time not in self._INTEGRATION_TIME_VALUES:
+            raise ValueError("integration_time is not in range")
+        self.integration_time = integration_time
+        self.device = i2c_device.I2CDevice(i2c, self.address)
+        self.enableSensor()
+    
+    def write(self, cmd, val):
+        """
+        write value into register on the colour sensor
+        cmd - register
+        val - value to be written
+        """
+        data = bytes([
+            cmd & 0xFF,
+            val & 0xFF,
+            (val >> 8) & 0xFF,
+        ])
+        with self.device as bus_device:
+            bus_device.write(data)
+    
+    def read(self, cmd):
+        """
+        read value from register on the colour sensor
+        cmd - register
+        """
+        register = bytes([cmd & 0xFF])
+        data = bytearray(2)
+        last_error = None
+        for _ in range(3):
+            try:
+                with self.device as bus_device:
+                    bus_device.write_then_readinto(register, data)
+                return data[0] | (data[1] << 8)
+            except OSError as error:
+                last_error = error
+                time.sleep(0.02)
+        raise last_error
+
+    def enableSensor(self):
+        """
+        activate Sensor
+        """
+        config = self._INTEGRATION_TIME_VALUES[self.integration_time]
+        config &= ~self.BIT_SD
+        config &= ~self.BIT_AF
+        config &= ~self.BIT_TRIG
+        self.write(self.REG_CONF, config)
+        time.sleep(self._INTEGRATION_TIME_DELAY[self.integration_time])
+        
+    def disableSensor(self):
+        """
+        deactivate Sensor
+        """
+        config = self.read(self.REG_CONF)
+        config |= self.BIT_SD
+        self.write(self.REG_CONF, config)
+        
+    def setIntegrationTime(self, integration_time):
+        """
+        set integration time with variable integration_time
+        integration_time - _INTEGRATION_TIME_VALUES 
+            INTEGRATION_TIME_40MS = 40 ms
+            INTEGRATION_TIME_80MS = 80 ms
+            INTEGRATION_TIME_160MS = 160 ms
+            INTEGRATION_TIME_320MS = 320 ms
+            INTEGRATION_TIME_640MS = 640 ms
+            INTEGRATION_TIME_1280MS = 1280 ms
+        """
+        if integration_time not in self._INTEGRATION_TIME_VALUES:
+            raise ValueError("integration_time is not in range")
+        config = self.read(self.REG_CONF)
+        config &= ~self.MASK_INTEGRATION_TIME
+        config |= self._INTEGRATION_TIME_VALUES[integration_time]
+        config &= ~self.BIT_SD
+        self.integration_time = integration_time
+        self.write(self.REG_CONF, config)
+        time.sleep(self._INTEGRATION_TIME_DELAY[self.integration_time])
+        
+    def getRed(self):
+        """
+        returns measured value for colour red
+        """
+        return self.read(self.REG_RED)
+
+    def getBlue(self):
+        """
+        returns measured value for colour blue
+        """
+        return self.read(self.REG_BLUE)
+
+    def getGreen(self):
+        """
+        returns measured value for colour green
+        """
+        return self.read(self.REG_GREEN)
+    
+    def getWhite(self):
+        """
+        returns measured value for colour white
+        """
+        return self.read(self.REG_WHITE)
+    
+    def getRGBW(self):
+        """
+        returns colour values from colour sensor - red, green, blue, white
+        """
+        red = self.getRed()
+        time.sleep(0.005)
+        green = self.getGreen()
+        time.sleep(0.005)
+        blue = self.getBlue()
+        time.sleep(0.005)
+        white = self.getWhite()
+        return red, green, blue, white
+
+    def forceMode(self):
+        """
+        forces measurement mode - triggers to start
+        """
+        config = self.read(self.REG_CONF)
+        config &= self.MASK_INTEGRATION_TIME
+        config |= self.BIT_AF
+        config |= self.BIT_TRIG
+        config &= ~self.BIT_SD
+        self.write(self.REG_CONF, config)
+        time.sleep(self._INTEGRATION_TIME_DELAY[self.integration_time])
+        
+    def autoMode(self):
+        """
+        automatic measurement mode
+        """
+        config = self.read(self.REG_CONF)
+        config &= self.MASK_INTEGRATION_TIME
+        config &= ~self.BIT_AF
+        config &= ~self.BIT_TRIG
+        config &= ~self.BIT_SD
+        self.write(self.REG_CONF, config)
+        time.sleep(self._INTEGRATION_TIME_DELAY[self.integration_time])
+    
+    def readAll(self):
+        """
+        returns most recognized colour and raw values
+        """
+        red, green, blue, white = self.getRGBW()
+        values = {
+            "red": red,
+            "green": green,
+            "blue": blue,
+        }
+
+        dominant_color = max(values, key=values.get)
+        return dominant_color, [red, green, blue, white]

joypi_advanced_raspberrypi-2.0.0/setup.py

@@ -1,14 +0,0 @@
-import setuptools
-from distutils.core import setup
-from codecs import open
-from os import path
-
-
-setuptools.setup(
-    name="JoyPi_Advanced_RaspberryPi",
-    setup_requires=["setuptools_scm"],
-    description="Library for the use of the Joy Pi Advanced",
-    author="Joy-IT",
-    license="MIT",
-    packages=setuptools.find_packages()
-)

joypi_advanced_raspberrypi-2.0.0/src/JoyPi_Advanced_RaspberryPi/colour.py

@@ -1,123 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-#  
-###################################################################################
-# Edited by Joy-IT
-# 
-###################################################################################
-#  Copyright 2020  <pi@kb>
-#  
-#  This program is free software; you can redistribute it and/or modify
-#  it under the terms of the GNU General Public License as published by
-#  the Free Software Foundation; either version 2 of the License, or
-#  (at your option) any later version.
-#  
-#  This program is distributed in the hope that it will be useful,
-#  but WITHOUT ANY WARRANTY; without even the implied warranty of
-#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-#  GNU General Public License for more details.
-#  
-#  You should have received a copy of the GNU General Public License
-#  along with this program; if not, write to the Free Software
-#  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
-#  MA 02110-1301, USA.
-#  
-#  Written by BitHead (Britany Head)
-#  https://forums.raspberrypi.com/viewtopic.php?t=263498
-# Step 1) Enable I2C in Raspi-Config (Interfacing Options)
-# Step 2) sudo apt-get install i2c-tools python3-smbus
-# Step 3) plug it in (don't forget your pull-up resistors) and run this program
-
-import smbus
-import time
-import threading
-import numpy as np
-
-class colour:
-
-    def __init__(self, i2c_address = 0x10):
-        """
-        initialize colour sensor
-        i2c_address - i2c_address of colour sensor (default 0x10)
-        """
-        self.address = i2c_address
-        self.bus = smbus.SMBus(1)
-        self.enableSensor()
-    
-    def write(self, cmd, val):
-        """
-        write value into register on the colour sensor
-        cmd - register
-        val - value to be written
-        """
-        self.bus.write_word_data(self.address, cmd, val)
-    
-    def read(self, cmd):
-        """
-        read value from register on the colour sensor
-        cmd - register
-        """
-        return self.bus.read_word_data(self.address, cmd)
-        
-    def enableSensor(self):
-        """
-        activate Sensor
-        """
-        conf = self.read(0x00) & 0x00FE
-        self.write(0x00, conf)
-        
-    def disableSensor(self):
-        """
-        deactivate Sensor
-        """
-        conf = (self.read(0x00) & 0x00FE) | 0x000
-        self.write(0x00, conf)
-        time.sleep(.001)
-    
-    def getRGBW(self):
-        """
-        returns colour values from colour sensor - red, green, blue, white
-        """
-        return self.read(0x08), self.read(0x09), int(self.read(0x0A) * 1.5), self.read(0x0B)
-        
-    def setIntegrationTime(self, int_time):
-        """
-        set integration time with variable int_time
-        int_time - integration time 
-            0 = 40 ms
-            1 = 80 ms
-            2 = 160 ms
-            3 = 320 ms
-            4 = 640 ms
-            5 = 1280 ms
-        """
-        if int_time < 0 or int_time > 5:
-            raise ValueError('int_time is not in range')
-        conf = self.read(0x00) & 0x0003
-        self.write(0x00, (conf | (int_time << 4)))
-        
-    def forceMode(self):
-        """
-        forces measurement mode - triggers to start
-        """
-        conf = (self.read(0x00) & 0x0072) | 0x0002
-        self.write(0x00, conf)
-        
-    def autoMode(self):
-        """
-        automatic measurement mode
-        """
-        conf = self.read(0x00) & 0x0070
-        self.write(0x00, conf)
-    
-    def readAll(self):
-        """
-        returns most recognized colour and raw values
-        """
-        r, g, b, w = self.getRGBW()
-        raw_val = [r, g, b, w]
-        dominant_col, dominant_val = "red", r
-        if g > dominant_val: dominant_col, dominant_val = "green", g
-        if b > dominant_val: dominant_col, dominant_val = "blue", b
-        
-        return dominant_col, raw_val