Merge branch 'release/2.0.0'

Author: timhendriks93

.github/workflows/ci.yml

@@ -7,14 +7,14 @@ jobs:
     name: "Build"
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - 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
     - name: Archive add-on ZIP
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: blender_servo_animation_addon.zip
         path: |
@@ -23,9 +23,9 @@ jobs:
     name: "Lint"
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Python 3.10
-      uses: actions/setup-python@v3
+      uses: actions/setup-python@v5
       with:
         python-version: "3.10"
         cache: "pip"
@@ -48,10 +48,11 @@ jobs:
         - {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"}
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Python
-      uses: actions/setup-python@v3
+      uses: actions/setup-python@v5
       with:
         python-version: "3.10"
         cache: "pip"
@@ -61,7 +62,7 @@ jobs:
         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@v3
+      uses: actions/cache/restore@v4
       with:
         path: blender-${{ matrix.blender.version }}
         key: blender-${{ matrix.blender.version }}
@@ -74,7 +75,7 @@ jobs:
         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@v3
+      uses: actions/cache/save@v4
       if: steps.restore-blender-cache.outputs.cache-hit != 'true'
       with:
         path: blender-${{ matrix.blender.version }}
@@ -83,7 +84,7 @@ jobs:
       run: |
         sudo ln -s "$(pwd)/blender-${{ matrix.blender.version }}/blender" /usr/bin/blender
     - name: Download add-on
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v4
       with:
         name: blender_servo_animation_addon.zip
     - name: Install add-on

.vscode/settings.json

@@ -1,6 +1,4 @@
 {
-    "python.linting.enabled": true,
-    "python.linting.pylintEnabled": true,
     "files.exclude": {
         "**/__pycache__": true
     },

addon/__init__.py

@@ -6,6 +6,7 @@
 from .ui.menu_panel import MenuPanel
 from .ops.json_export import JsonExport
 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
@@ -32,6 +33,7 @@
     MenuPanel,
     ArduinoExport,
     JsonExport,
+    BinaryExport,
     StopLiveMode,
     StartLiveMode,
     InstallDependencies,
@@ -42,6 +44,7 @@
 def menu_func_export(self, _):
     self.layout.operator(ArduinoExport.bl_idname)
     self.layout.operator(JsonExport.bl_idname)
+    self.layout.operator(BinaryExport.bl_idname)
 
 
 def menu_func_timeline(self, _):

addon/ops/arduino_export.py

@@ -1,41 +1,24 @@
-import re
 import bpy
 
 from bpy.types import Operator
 from bpy_extras.io_utils import ExportHelper
 from .base_export import BaseExport
-from ..utils.servo_settings import get_pose_bone_by_servo_id
 
 
 class ArduinoExport(Operator, BaseExport, ExportHelper):
-    bl_idname = "export_anim.servo_positions_arduino"
-    bl_label = "Animation Servo Positions (.h)"
+    bl_idname = "export_anim.servo_animation_arduino"
+    bl_label = "Servo Animation (.h)"
     bl_description = "Save an Arduino header file with servo position values of the active armature"
 
     filename_ext = ".h"
-    position_chunk_size = 50
+    chunk_size = 12
 
     filter_glob: bpy.props.StringProperty(
         default="*.h",
         options={'HIDDEN'},
         maxlen=255
     )
 
-    progmem: bpy.props.BoolProperty(
-        name="Add PROGMEM modifier",
-        description=(
-            "Add the PROGMEM modifier to each position array which enables "
-            "an Arduino micro controller to handle large arrays"
-        ),
-        default=True
-    )
-
-    animation_variables: bpy.props.BoolProperty(
-        name="Add animation variables",
-        description="Add the fps and frames count as constant variables",
-        default=True
-    )
-
     namespace: bpy.props.BoolProperty(
         name="Add scene namespace",
         description=(
@@ -44,53 +27,60 @@ class ArduinoExport(Operator, BaseExport, ExportHelper):
         )
     )
 
-    def export(self, positions, context):
-        variable_type = 'int' if self.precision == 0 else 'float'
+    def export(self, positions, filepath, context):
         fps, frames, seconds = self.get_time_meta(context.scene)
         filename = self.get_blend_filename()
 
         content = (
             "/*\n  Blender Servo Animation Positions\n\n  "
             f"FPS: {fps}\n  Frames: {frames}\n  Seconds: {seconds}\n  "
-            f"Bones: {len(positions)}\n  Armature: {context.object.name}\n  "
-            f"Scene: {context.scene.name}\n  File: {filename}\n*/\n"
+            f"Bones: {len(positions[0])}\n  Armature: {context.object.name}\n  "
+            f"Scene: {context.scene.name}\n  File: {filename}\n*/\n\n"
+            "#include <Arduino.h>\n"
         )
 
-        if self.progmem or self.animation_variables:
-            content += "\n#include <Arduino.h>\n"
+        commands = self.get_commands(positions)
+        length = len(commands)
+        lines = self.join_by_chunk_size(commands, self.chunk_size)
 
         if self.namespace:
-            content += f"\nnamespace {context.scene.name} {{\n"
+            scene_name = self.format_scene_name()
+            content += f"\nnamespace {scene_name} {{\n"
 
-        if self.animation_variables:
-            content += (
-                f"\nconst byte FPS = {fps};"
-                f"\nconst int FRAMES = {frames};\n"
-            )
+        content += (
+            f"\nconst byte FPS = {fps};"
+            f"\nconst int FRAMES = {frames};"
+            f"\nconst int LENGTH = {length};\n\n"
+        )
 
-        for servo_id in positions:
-            pose_bone = get_pose_bone_by_servo_id(servo_id, context.scene)
-            bone_positions = list(map(str, positions[servo_id]))
-            variable_name = re.sub('[^a-zA-Z0-9_]', '', pose_bone.bone.name)
-            array_size = "FRAMES" if self.animation_variables else frames
-            content += (
-                f"\n// Servo ID: {servo_id}\n"
-                f"const {variable_type} {variable_name}[{array_size}] "
-            )
+        content += f'const byte PROGMEM ANIMATION_DATA[LENGTH] = {{\n{lines}}};\n'
 
-            if self.progmem:
-                content += 'PROGMEM '
+        if self.namespace:
+            content += f"\n}} // namespace {scene_name}\n"
 
-            content += '= {\n'
+        with open(filepath, 'w', encoding='utf-8') as file:
+            file.write(content)
 
-            for i in range(0, len(bone_positions), self.position_chunk_size):
-                content += '  ' + \
-                    ', '.join(
-                        bone_positions[i:i + self.position_chunk_size]) + ',\n'
+    @classmethod
+    def join_by_chunk_size(cls, iterable, chunk_size):
+        output = ''
+        str_iterable = list(map(cls.format_hex, iterable))
 
-            content += '};\n'
+        for i in range(0, len(str_iterable), chunk_size):
+            output += '    ' + ', '.join(str_iterable[i:i + chunk_size]) + ',\n'
 
-        if self.namespace:
-            content += f"\n}} // namespace {context.scene.name}\n"
+        return output
+
+    @classmethod
+    def format_hex(cls, byte):
+        return f'{byte:#04x}'
+
+    @classmethod
+    def format_scene_name(cls):
+        valid_chars = set('abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_')
+        scene_name = ''.join(c if c in valid_chars else '_' for c in bpy.context.scene.name)
+
+        if scene_name[0].isdigit():
+            scene_name = '_' + scene_name
 
-        return content
+        return scene_name

addon/ops/base_export.py

@@ -6,12 +6,14 @@
 
 
 class BaseExport:
-    precision: bpy.props.IntProperty(
-        name="Precision",
-        description="The number of decimal digits to round to",
-        default=0,
-        min=0,
-        max=6
+    COMMAND_START = 0x3C
+    COMMAND_END = 0x3E
+    LINE_BREAK = 10
+
+    skip_duplicates: bpy.props.BoolProperty(
+        name="Skip unchanged positions",
+        description="Skip positions which haven't changed since the last frame",
+        default=True
     )
 
     @classmethod
@@ -32,8 +34,8 @@ def execute(self, context):
             bpy.ops.servo_animation.stop_live_mode()
 
         try:
-            positions = calculate_positions(context, self.precision)
-            content = self.export(positions, context)
+            positions = calculate_positions(context, self.skip_duplicates)
+            self.export(positions, self.filepath, context)
         except RuntimeError as error:
             self.report({'ERROR'}, str(error))
 
@@ -44,16 +46,33 @@ def execute(self, context):
             if original_live_mode is True:
                 bpy.ops.servo_animation.start_live_mode('INVOKE_DEFAULT')
 
-        with open(self.filepath, 'w', encoding='utf-8') as file:
-            file.write(content)
-
         end = time.time()
         duration = round(end - start)
+        unit = "second" if duration == 1 else "seconds"
         self.report(
-            {'INFO'}, f"Animation servo positions exported after {duration} seconds")
+            {'INFO'}, f"Animation servo positions exported after {duration} {unit}")
 
         return {'FINISHED'}
 
+    def get_commands(self, positions):
+        commands = []
+
+        for frame_positions in positions:
+            for servo_id in frame_positions:
+                position = frame_positions[servo_id]
+                commands += self.get_command(servo_id, position)
+
+            commands.append(self.LINE_BREAK)
+
+        return commands
+
+    def get_command(self, servo_id, position):
+        command = [self.COMMAND_START, servo_id]
+        command += position.to_bytes(2, 'big')
+        command += [self.COMMAND_END]
+
+        return command
+
     @staticmethod
     def get_time_meta(scene):
         fps = scene.render.fps

addon/ops/binary_export.py

@@ -0,0 +1,25 @@
+import bpy
+
+from bpy.types import Operator
+from bpy_extras.io_utils import ExportHelper
+from .base_export import BaseExport
+
+
+class BinaryExport(Operator, BaseExport, ExportHelper):
+    bl_idname = "export_anim.servo_animation_binary"
+    bl_label = "Servo Animation (.bin)"
+    bl_description = "Save a binary file with servo position values of the active armature"
+
+    filename_ext = ".bin"
+
+    filter_glob: bpy.props.StringProperty(
+        default="*.bin",
+        options={'HIDDEN'},
+        maxlen=255
+    )
+
+    def export(self, positions, filepath, _context):
+        commands = self.get_commands(positions)
+
+        with open(filepath, 'wb') as file:
+            file.write(bytes(commands))