Merge branch 'feature/extension_conversion' into develop

Author: timhendriks93

.github/workflows/ci.yml

@@ -6,13 +6,14 @@ jobs:
   build:
     name: "Build"
     runs-on: ubuntu-latest
+    container: linuxserver/blender:latest
     steps:
     - uses: actions/checkout@v4
     - name: Build add-on
       run: |
         cp -R addon servo_animation
         cp README.md LICENSE servo_animation
-        zip -r blender_servo_animation_addon servo_animation
+        ./scripts/build.sh
     - name: Archive add-on ZIP
       uses: actions/upload-artifact@v4
       with:
@@ -28,7 +29,6 @@ jobs:
       uses: actions/setup-python@v5
       with:
         python-version: "3.10"
-        cache: "pip"
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
@@ -40,58 +40,27 @@ jobs:
   test:
     name: "Test"
     needs: build
-    runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
-        blender: 
-        - {version: "2.90.0", dir: "2.90"}
-        - {version: "3.1.0", dir: "3.1"}
-        - {version: "3.5.0", dir: "3.5"}
-        - {version: "4.0.0", dir: "4.0"}
+        version:
+        - "4.2.0"
+        - "4.3.0"
+        - "4.3.2"
+    runs-on: ubuntu-latest
+    container: linuxserver/blender:${{ matrix.version }}
     steps:
     - uses: actions/checkout@v4
-    - name: Set up Python
-      uses: actions/setup-python@v5
-      with:
-        python-version: "3.10"
-        cache: "pip"
-    - name: Install dependencies
-      run: |
-        sudo apt-get update
-        sudo apt-get install --no-install-recommends -y unzip wget xz-utils libxi6 libxxf86vm1 libxfixes3 libxrender1 libgl1
-    - name: Restore Blender cache
-      id: restore-blender-cache
-      uses: actions/cache/restore@v4
-      with:
-        path: blender-${{ matrix.blender.version }}
-        key: blender-${{ matrix.blender.version }}
-    - name: Download Blender
-      if: steps.restore-blender-cache.outputs.cache-hit != 'true'
-      run: |
-        python -m pip install --upgrade pip
-        pip install blender-downloader
-        blender-downloader ${{ matrix.blender.version }}
-        mkdir -p blender-${{ matrix.blender.version }}
-        tar xf *.tar.xz -C blender-${{ matrix.blender.version }} --strip-components 1
-    - name: Cache Blender
-      uses: actions/cache/save@v4
-      if: steps.restore-blender-cache.outputs.cache-hit != 'true'
-      with:
-        path: blender-${{ matrix.blender.version }}
-        key: blender-${{ matrix.blender.version }}
-    - name: Create Blender symlink
-      run: |
-        sudo ln -s "$(pwd)/blender-${{ matrix.blender.version }}/blender" /usr/bin/blender
     - name: Download add-on
       uses: actions/download-artifact@v4
       with:
         name: blender_servo_animation_addon.zip
     - name: Install add-on
       run: |
-        unzip blender_servo_animation_addon.zip
-        sudo ln -s "$(pwd)/servo_animation" "$(pwd)/blender-${{ matrix.blender.version }}/${{ matrix.blender.dir }}/scripts/addons/servo_animation"
+        ./scripts/install.sh
+    - name: Install test dependencies inside Blender
+      run: |
+        ./scripts/prepare.sh
     - name: Run tests inside Blender
       run: |
-        ./tests/prepare.sh
-        ./tests/test.sh
+        ./scripts/test.sh

.gitignore

@@ -2,4 +2,5 @@ __pycache__
 .vscode/*
 !.vscode/settings.json
 *.blend1
-tests/results.txt
+tests/results.txt
+*.zip

README.md

@@ -18,14 +18,9 @@ Also check out the [Blender Servo Animation Arduino Library](https://github.com/
 
 ## Installation
 
-> Note: this Add-on is compatible with Blender version **2.90 or higher**.
+> Note: the latest version of this Add-on is compatible with Blender  **4.2 or higher**.
 
-1. Download the [latest version of the Add-on](https://github.com/timhendriks93/blender-servo-animation/releases/latest/download/blender_servo_animation_addon.zip) as a ZIP archive.
-2. Open Blender and go to `File > Preferences > Add-ons`.
-3. Click the `Install...` button, select the previously downloaded ZIP and click `Install Add-on`.
-4. Enable the Add-on by checking the checkbox in the Add-ons list.
-
-More information and screenshots can be found in the official [Blender Manual](https://docs.blender.org/manual/en/latest/editors/preferences/addons.html#add-ons).
+The Add-on can be installed as a regular [Blender Extension](https://docs.blender.org/manual/en/latest/editors/preferences/extensions.html).
 
 ## Providing Servo Settings
 
@@ -73,16 +68,19 @@ Once all servo settings are provided and your animation is ready, you can calcul
 
 Make sure to select the armature containing the bones/servos you want to export and choose the desired format in the `File > Export` menu:
 
-![Servo Settings panel](images/export_menu.png)
+![Export Menu Top](images/export_menu.png)
+
+Alternatively, you can also trigger the export via the timeline menu which is shown in the live mode section below:
 
-Alternatively, you can also trigger the export via the timeline menu which is shown in the live mode section below.
+![Export Menu Timeline](images/timeline_menu.png)
 
 ### Export Formats
 
-There are two different formats to choose from:
+There are 3 different formats to choose from:
 
 1. `Animation Servo Positions (.h)`: An Arduino/C/C++ style header file which can be easily included in an Arduino project.
 2. `Animation Servo Positions (.json)`: A simple (non-formatted) JSON file which can be used in a more generic way.
+3. `Animation Servo Positions (.bin)`: A binary file which can be used to store the animation data on an SD card.
 
 ### Using the Exported Data
 
@@ -99,21 +97,13 @@ To make the animation process even more intuitive, you can enable the `Live mode
 
 This will allow you to control your servos in real-time from within Blender.
 
-### Installing dependencies
-
-After enabling the add-on, you can find the `Servo Positions` popover menu in the header of the timeline. Before using the live mode feature of this add-on, you might have to install some Python dependencies first by pressing the `Install dependencies` button. This will automatically install the required `pip` packages and requires an active internet connection. This process can might take a few seconds depending on the speed of your internet connection.
-
-![Install dependencies button](images/live_mode_dependencies.png)
-
-Afterwards you can prepare and control the connection to be used for the `Live mode` via this menu. For additional convenience, you will also find buttons to export the servo positions here.
-
 ### Setup a connection
 
 To use the `Live Mode`, you will need to prepare a receiver which will interpret the received commands and use them to control the servo motors accordingly.
 
 In most cases, the receiver can be considered an Arduino compatible micro controller. As a first step, a connection method should be selected via the `Method` dropdown menu.
 
-![Timeline menu](images/timeline_menu.gif)
+![Livemode Timeline menu](images/timeline_menu.png)
 
 > Note: starting the `Live Mode` will immediately send the position values for all servos based on the current frame. Make sure that this will not break anything, as the servos will try to move to their new position as fast as possible.
 

addon/__init__.py

@@ -8,23 +8,9 @@
 from .ops.arduino_export import ArduinoExport
 from .ops.binary_export import BinaryExport
 from .ops.stop_live_mode import StopLiveMode
-from .ops.install_dependencies import InstallDependencies
 from .ops.start_live_mode import StartLiveMode
 from .ops.calibrate_servo import CalibrateServo
 
-bl_info = {
-    "name": "Export Animation as Servo Position Values",
-    "author": "Tim Hendriks",
-    "version": (1, 4, 0),
-    "blender": (2, 90, 0),
-    "location": "Bone Properties > Servo Settings | File > Import-Export",
-    "description": "Exports armature animations as servo position values.",
-    "warning": "",
-    "doc_url": "https://github.com/timhendriks93/blender-servo-animation#readme",
-    "support": "COMMUNITY",
-    "category": "Import-Export",
-}
-
 
 classes = (
     BonePropertyGroup,
@@ -36,7 +22,6 @@
     BinaryExport,
     StopLiveMode,
     StartLiveMode,
-    InstallDependencies,
     CalibrateServo
 )
 

addon/blender_manifest.toml

@@ -0,0 +1,25 @@
+schema_version = "1.0.0"
+
+id = "servo_animation"
+version = "2.0.0"
+name = "Servo Animation"
+tagline = "Export your Blender animation to servo position values"
+maintainer = "Tim Hendriks <[email protected]>"
+type = "add-on"
+
+website = "https://github.com/timhendriks93/blender-servo-animation"
+
+tags = ["Animation", "Import-Export", "Rigging"]
+
+blender_version_min = "4.2.0"
+
+license = [
+  "SPDX:GPL-3.0-or-later",
+]
+
+wheels = [
+  "./wheels/pyserial-3.5-py2.py3-none-any.whl",
+  "./wheels/websocket_client-1.5.1-py3-none-any.whl",
+]
+
+files = "Export animation servo position values to disk"

addon/ops/install_dependencies.py

@@ -1,10 +1,9 @@
-# pylint: disable=import-outside-toplevel
-
 import bpy
+import serial
+import websocket
 
 from bpy.types import Operator
 from ..utils.live_mode import LiveMode
-from ..ops.install_dependencies import InstallDependencies
 
 
 class StartLiveMode(Operator):
@@ -32,8 +31,7 @@ def poll(cls, context):
         servo_animation = context.window_manager.servo_animation
 
         return (
-            InstallDependencies.installed()
-            and not LiveMode.is_connected()
+            not LiveMode.is_connected()
             and (
                 (
                     servo_animation.live_mode_method == LiveMode.METHOD_SERIAL
@@ -67,8 +65,6 @@ def execute(self, context):
         return {'CANCELLED'}
 
     def open_serial(self, _context):
-        import serial
-
         try:
             serial_connection = serial.Serial(self.serial_port, self.serial_baud)
         except (serial.SerialException, ValueError):
@@ -93,8 +89,6 @@ def open_serial(self, _context):
         return {'FINISHED'}
 
     def open_socket(self, _context):
-        import websocket
-
         socket_url = f"ws://{self.socket_host}:{self.socket_port}{self.socket_path}"
         socket_connection = websocket.WebSocket()
         socket_connection.settimeout(1)

addon/ops/start_live_mode.py

@@ -3,7 +3,6 @@
 from ..ops.arduino_export import ArduinoExport
 from ..ops.binary_export import BinaryExport
 from ..ops.stop_live_mode import StopLiveMode
-from ..ops.install_dependencies import InstallDependencies
 from ..ops.start_live_mode import StartLiveMode
 from ..utils.live_mode import LiveMode
 
@@ -22,10 +21,7 @@ def draw(self, context):
         col = layout.column()
         col.label(text="Live Mode")
 
-        if InstallDependencies.installed():
-            self.draw_live_mode(context, layout, col)
-        else:
-            self.draw_live_mode_deps(col)
+        self.draw_live_mode(context, layout, col)
 
         col = layout.column(align=True)
         col.label(text="Export")
@@ -63,8 +59,3 @@ def draw_live_mode(cls, context, layout, col):
 
         col = layout.column()
         col.prop(servo_animation, "position_jump_handling")
-
-    @classmethod
-    def draw_live_mode_deps(cls, col):
-        col.label(text="You are missing dependencies", icon="ERROR")
-        col.operator(InstallDependencies.bl_idname, text="Install dependencies")

addon/requirements.txt

@@ -1,8 +1,12 @@
-# pylint: disable=import-outside-toplevel, broad-exception-caught
+# pylint: disable=broad-exception-caught
 
 import time
 import math
 import bpy
+import serial
+import websocket
+
+from serial.tools import list_ports
 
 from ..utils.servo_settings import get_active_pose_bones
 from ..utils.converter import calculate_position
@@ -26,9 +30,6 @@ def set_connection(cls, connection):
 
     @classmethod
     def is_connected(cls):
-        import serial
-        import websocket
-
         method = bpy.context.window_manager.servo_animation.live_mode_method
 
         if method == LiveMode.METHOD_SERIAL:
@@ -63,8 +64,6 @@ def disable_handler(cls):
 
     @classmethod
     def get_serial_ports(cls):
-        from serial.tools import list_ports
-
         ports = []
 
         for port in list_ports.comports():