IS-Matrix-Forge 1.0.0.dev1__tar.gz

is_matrix_forge-1.0.0.dev1/LICENSE.md

@@ -0,0 +1,19 @@
+Copyright (c) 2025 Inspyre-Softworks
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software (led-matrix-battery) and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

is_matrix_forge-1.0.0.dev1/PKG-INFO

@@ -0,0 +1,190 @@
+Metadata-Version: 2.3
+Name: IS-Matrix-Forge
+Version: 1.0.0.dev1
+Summary: 
+License: MIT
+Keywords: led,matrix,framework,hardware
+Author: Taylor B.
+Author-email: t.blackstone@inspyre.tech
+Requires-Python: >=3.12,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Provides-Extra: clipboard-support
+Requires-Dist: chime (>=0.7.0,<0.8.0)
+Requires-Dist: clipboard (>=0.0.4,<0.0.5) ; extra == "clipboard-support"
+Requires-Dist: easy-exit-calls (>=1.0.0.dev1,<2.0.0)
+Requires-Dist: inspy-logger (>=3.2.3,<4.0.0)
+Requires-Dist: inspyre-toolbox (>=1.6.0.dev23)
+Requires-Dist: opencv-python (>=4.11.0.86,<5.0.0.0)
+Requires-Dist: pillow (>=11.2.1,<12.0.0)
+Requires-Dist: pyserial (>=3.5,<4.0)
+Requires-Dist: pysimplegui-4-foss (>=4.60.4.1,<5.0.0.0)
+Requires-Dist: tk (>=0.1.0,<0.2.0)
+Description-Content-Type: text/markdown
+
+# LED Matrix Battery Monitor
+
+A Python application that displays your computer's battery status on an LED matrix display. The application monitors battery level and power state, providing visual feedback on an LED matrix and audio notifications when power is plugged or unplugged.
+
+## Project Description and Purpose
+
+The LED Matrix Battery Monitor is designed to provide a visual representation of your computer's battery status on an external LED matrix display. It serves as a convenient way to monitor battery levels without having to check your computer's status bar, especially useful for setups where the status bar might not be visible or when you want a more noticeable indicator.
+
+Key features:
+- Real-time battery level display on an LED matrix
+- Visual animations when power is plugged in
+- Audio notifications when power state changes (plugged/unplugged)
+- Configurable checking intervals
+- Support for multiple LED matrices
+
+## Hardware Requirements
+
+- LED Matrix display with dimensions 9x34 (compatible with the project's specifications)
+- Serial connection to the computer (USB)
+- The LED matrix should have the following hardware identifiers:
+  - VID: 0x32AC
+  - PID: 0x20
+  - Serial Number Prefix: FRAK
+
+## Software Dependencies
+
+This project requires Python 3.12 or newer and the following dependencies:
+
+- chime (>=0.7.0,<0.8.0) - For audio notifications
+- pyserial (>=3.5,<4.0) - For serial communication with the LED matrix
+- inspy-logger (>=3.2.3,<4.0.0) - For logging
+- inspyre-toolbox (>=1.6.0) - Utility functions
+- pillow (>=11.2.1,<12.0.0) - Image processing
+- opencv-python (>=4.11.0.86,<5.0.0.0) - Image processing
+- pysimplegui-4-foss (>=4.60.4.1,<5.0.0.0) - GUI components
+- tk (>=0.1.0,<0.2.0) - GUI toolkit
+- easy-exit-calls (>=1.0.0.dev1,<2.0.0) - Exit handling
+- psutil - For battery status monitoring
+
+## Installation Instructions
+
+### Using Poetry (Recommended)
+
+1. Clone the repository:
+   ```
+   git clone https://github.com/Inspyre-Softworks/led-matrix-battery.git
+   cd led-matrix-battery
+   ```
+
+2. Install dependencies using Poetry:
+   ```
+   poetry install
+   ```
+
+3. Activate the virtual environment:
+   ```
+   poetry shell
+   ```
+
+### Using pip
+
+1. Clone the repository:
+   ```
+   git clone https://github.com/Inspyre-Softworks/led-matrix-battery.git
+   cd led-matrix-battery
+   ```
+
+2. Install the package:
+   ```
+   pip install .
+   ```
+
+## Usage Examples
+
+### Basic Usage
+
+To start monitoring your battery with default settings:
+
+```python
+from is_matrix_forge.monitor import run_power_monitor
+from is_matrix_forge.led_matrix.helpers.device import DEVICES
+
+# Get the first available LED matrix device
+device = DEVICES[0]
+
+# Start monitoring with default settings
+run_power_monitor(device)
+```
+
+### Custom Configuration
+
+To customize the monitoring behavior:
+
+```python
+from is_matrix_forge.monitor import run_power_monitor
+from is_matrix_forge.led_matrix.helpers.device import DEVICES
+from pathlib import Path
+
+# Get the first available LED matrix device
+device = DEVICES[0]
+
+# Custom sound files
+plugged_sound = Path("path/to/custom_plugged_sound.wav")
+unplugged_sound = Path("path/to/custom_unplugged_sound.wav")
+
+# Start monitoring with custom settings
+run_power_monitor(
+    device,
+    battery_check_interval=10,  # Check every 10 seconds
+    plugged_alert=plugged_sound,
+    unplugged_alert=unplugged_sound
+)
+```
+
+### Running in a Thread
+
+To run the monitor in a background thread:
+
+```python
+from is_matrix_forge.monitor import run_power_monitor_threaded
+from is_matrix_forge.led_matrix.helpers.device import DEVICES
+
+# Get the first available LED matrix device
+device = DEVICES[0]
+
+# Start monitoring in a background thread
+monitor = run_power_monitor_threaded(device)
+# ``monitor`` is a :class:`threading.Thread` instance
+```
+
+## Troubleshooting
+
+### LED Matrix Not Detected
+
+1. Check that the LED matrix is properly connected to your computer.
+2. Verify that the LED matrix has the correct hardware identifiers (VID, PID, SN_PREFIX).
+3. Make sure you have the necessary permissions to access the serial port.
+4. Try running the application with administrator/root privileges.
+
+### Audio Notifications Not Working
+
+1. Ensure your system's audio is working correctly.
+2. Check that the WAV files for notifications exist in the expected locations.
+3. Verify that the chime library is properly installed.
+
+### Battery Status Not Updating
+
+1. Make sure psutil is properly installed.
+2. Check that your system supports battery status monitoring through psutil.
+3. Try increasing the battery_check_interval to reduce CPU usage.
+
+### Animation Issues
+
+1. Verify that the LED matrix is functioning correctly.
+2. Check that the matrix dimensions match the expected 9x34 size.
+3. Try clearing the matrix and restarting the application.
+
+## Contributing
+
+Contributions to the LED Matrix Battery Monitor are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE.md file for details.

is_matrix_forge-1.0.0.dev1/README.md

@@ -0,0 +1,164 @@
+# LED Matrix Battery Monitor
+
+A Python application that displays your computer's battery status on an LED matrix display. The application monitors battery level and power state, providing visual feedback on an LED matrix and audio notifications when power is plugged or unplugged.
+
+## Project Description and Purpose
+
+The LED Matrix Battery Monitor is designed to provide a visual representation of your computer's battery status on an external LED matrix display. It serves as a convenient way to monitor battery levels without having to check your computer's status bar, especially useful for setups where the status bar might not be visible or when you want a more noticeable indicator.
+
+Key features:
+- Real-time battery level display on an LED matrix
+- Visual animations when power is plugged in
+- Audio notifications when power state changes (plugged/unplugged)
+- Configurable checking intervals
+- Support for multiple LED matrices
+
+## Hardware Requirements
+
+- LED Matrix display with dimensions 9x34 (compatible with the project's specifications)
+- Serial connection to the computer (USB)
+- The LED matrix should have the following hardware identifiers:
+  - VID: 0x32AC
+  - PID: 0x20
+  - Serial Number Prefix: FRAK
+
+## Software Dependencies
+
+This project requires Python 3.12 or newer and the following dependencies:
+
+- chime (>=0.7.0,<0.8.0) - For audio notifications
+- pyserial (>=3.5,<4.0) - For serial communication with the LED matrix
+- inspy-logger (>=3.2.3,<4.0.0) - For logging
+- inspyre-toolbox (>=1.6.0) - Utility functions
+- pillow (>=11.2.1,<12.0.0) - Image processing
+- opencv-python (>=4.11.0.86,<5.0.0.0) - Image processing
+- pysimplegui-4-foss (>=4.60.4.1,<5.0.0.0) - GUI components
+- tk (>=0.1.0,<0.2.0) - GUI toolkit
+- easy-exit-calls (>=1.0.0.dev1,<2.0.0) - Exit handling
+- psutil - For battery status monitoring
+
+## Installation Instructions
+
+### Using Poetry (Recommended)
+
+1. Clone the repository:
+   ```
+   git clone https://github.com/Inspyre-Softworks/led-matrix-battery.git
+   cd led-matrix-battery
+   ```
+
+2. Install dependencies using Poetry:
+   ```
+   poetry install
+   ```
+
+3. Activate the virtual environment:
+   ```
+   poetry shell
+   ```
+
+### Using pip
+
+1. Clone the repository:
+   ```
+   git clone https://github.com/Inspyre-Softworks/led-matrix-battery.git
+   cd led-matrix-battery
+   ```
+
+2. Install the package:
+   ```
+   pip install .
+   ```
+
+## Usage Examples
+
+### Basic Usage
+
+To start monitoring your battery with default settings:
+
+```python
+from is_matrix_forge.monitor import run_power_monitor
+from is_matrix_forge.led_matrix.helpers.device import DEVICES
+
+# Get the first available LED matrix device
+device = DEVICES[0]
+
+# Start monitoring with default settings
+run_power_monitor(device)
+```
+
+### Custom Configuration
+
+To customize the monitoring behavior:
+
+```python
+from is_matrix_forge.monitor import run_power_monitor
+from is_matrix_forge.led_matrix.helpers.device import DEVICES
+from pathlib import Path
+
+# Get the first available LED matrix device
+device = DEVICES[0]
+
+# Custom sound files
+plugged_sound = Path("path/to/custom_plugged_sound.wav")
+unplugged_sound = Path("path/to/custom_unplugged_sound.wav")
+
+# Start monitoring with custom settings
+run_power_monitor(
+    device,
+    battery_check_interval=10,  # Check every 10 seconds
+    plugged_alert=plugged_sound,
+    unplugged_alert=unplugged_sound
+)
+```
+
+### Running in a Thread
+
+To run the monitor in a background thread:
+
+```python
+from is_matrix_forge.monitor import run_power_monitor_threaded
+from is_matrix_forge.led_matrix.helpers.device import DEVICES
+
+# Get the first available LED matrix device
+device = DEVICES[0]
+
+# Start monitoring in a background thread
+monitor = run_power_monitor_threaded(device)
+# ``monitor`` is a :class:`threading.Thread` instance
+```
+
+## Troubleshooting
+
+### LED Matrix Not Detected
+
+1. Check that the LED matrix is properly connected to your computer.
+2. Verify that the LED matrix has the correct hardware identifiers (VID, PID, SN_PREFIX).
+3. Make sure you have the necessary permissions to access the serial port.
+4. Try running the application with administrator/root privileges.
+
+### Audio Notifications Not Working
+
+1. Ensure your system's audio is working correctly.
+2. Check that the WAV files for notifications exist in the expected locations.
+3. Verify that the chime library is properly installed.
+
+### Battery Status Not Updating
+
+1. Make sure psutil is properly installed.
+2. Check that your system supports battery status monitoring through psutil.
+3. Try increasing the battery_check_interval to reduce CPU usage.
+
+### Animation Issues
+
+1. Verify that the LED matrix is functioning correctly.
+2. Check that the matrix dimensions match the expected 9x34 size.
+3. Try clearing the matrix and restarting the application.
+
+## Contributing
+
+Contributions to the LED Matrix Battery Monitor are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE.md file for details.

is_matrix_forge-1.0.0.dev1/is_matrix_forge/__init__.py

@@ -0,0 +1,8 @@
+"""
+Author: Taylor B. tayjaybabee@gmail.com
+Date: 2025-04-15 09:15:25
+LastEditors: Taylor B. tayjaybabee@gmail.com
+LastEditTime: 2025-04-15 09:24:40
+FilePath: is_matrix_forge/__init__.py
+Description: 这是默认设置,可以在设置》工具》File Description中进行配置
+"""

is_matrix_forge-1.0.0.dev1/is_matrix_forge/assets/__init__.py

@@ -0,0 +1,8 @@
+"""
+Author: Taylor B. tayjaybabee@gmail.com
+Date: 2025-04-15 09:15:37
+LastEditors: Taylor B. tayjaybabee@gmail.com
+LastEditTime: 2025-04-15 09:24:40
+FilePath: is_matrix_forge/assets/__init__.py
+Description: 这是默认设置,可以在设置》工具》File Description中进行配置
+"""

is_matrix_forge-1.0.0.dev1/is_matrix_forge/assets/audio/__init__.py

@@ -0,0 +1,36 @@
+from chime import play_wav
+from .files import AUDIO_MAP as PLUG_ALERT_MAP
+from is_matrix_forge.log_engine import ROOT_LOGGER as PARENT_LOGGER
+
+
+MOD_LOGGER = PARENT_LOGGER.get_child('assets.audio')
+
+
+def alert(alert_type: str):
+    """
+    Plays an alert sound.
+
+    Parameters:
+        alert_type (str):
+            The type of alert sound to play.
+    """
+    log = MOD_LOGGER.get_child('alert')
+
+    if not isinstance(alert_type, str):
+        log.error(f'"alert_type" must be a string, not {type(alert_type)}')
+        raise TypeError(f'alert_type must be a string, not {type(alert_type)}')
+
+    alert_type = alert_type.lower().strip()
+    log.debug(f'Checking if alert_type is valid: {alert_type} ({type(alert_type)})')
+    if alert_type not in PLUG_ALERT_MAP:
+        log.error(f'Invalid alert_type: {alert_type}')
+        raise ValueError(f'alert_type must be one of {", ".join(PLUG_ALERT_MAP.keys())}')
+
+    log.debug(f'Playing alert sound: {alert_type}')
+    play_wav(PLUG_ALERT_MAP[alert_type])
+
+
+__all__ = [
+    'alert'
+]
+

is_matrix_forge-1.0.0.dev1/is_matrix_forge/assets/audio/files/__init__.py

@@ -0,0 +1,53 @@
+from pathlib import Path
+from is_matrix_forge.log_engine import ROOT_LOGGER as PARENT_LOGGER
+
+
+MOD_LOGGER = PARENT_LOGGER.get_child('assets.audio.files')
+
+
+CUR_DIR = Path(__file__).parent.expanduser().resolve().absolute()
+MOD_LOGGER.debug(f'Audio files directory: {CUR_DIR}')
+
+AUDIO_MAP = {
+    'plugged': CUR_DIR / 'plugged.wav',
+    'unplugged': CUR_DIR / 'unplugged.wav'
+}
+
+
+def integrity_check():
+    """
+    Checks the integrity of the audio files.
+
+    Raises:
+        FileNotFoundError:
+            If any of the audio files are not found.
+
+    Returns:
+        None
+    """
+    log = MOD_LOGGER.get_child('integrity_check')
+    log.debug('Checking audio files...')
+    for file in AUDIO_MAP.values():
+        log.debug(f'Checking file: {file}')
+        if not file.exists():
+            log.error(f'File not found: {file}')
+            raise FileNotFoundError(f'Audio file not found: {file}')
+
+        if not file.is_file():
+            log.error(f'File is not a file: {file}')
+            raise FileNotFoundError(f'Audio file not found: {file}')
+
+    log.debug('Audio files are valid.')
+    return True
+
+
+MOD_LOGGER.debug('Performing integrity check...')
+
+if not integrity_check():
+    MOD_LOGGER.error('Audio files are invalid.')
+    raise FileNotFoundError('Audio files are invalid.')
+
+
+__all__ = [
+    'AUDIO_MAP',
+]