Merge remote-tracking branch 'upstream/master'

LynxCrew · May 19, 2024 · 1448fa5 · 1448fa5
2 parents 1355e09 + 83b77ca
commit 1448fa5
Show file tree

Hide file tree

Showing 13 changed files with 936 additions and 322 deletions.
diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
@@ -28,23 +28,23 @@ jobs:
             ASSET_MIME: application/vnd.microsoft.portable-executable
             POETRY_FOLDER: C:\Users\runneradmin\.local
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v4
     - name: Set up Python 3.9
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: 3.9
     #- name: cache poetry install
     #  uses: actions/cache@v3
     #  with:
     #    path: ${{matrix.POETRY_FOLDER}}
     #    key: poetry-1.3.3-0
-    - uses: snok/install-poetry@v1.3.3
+    - uses: snok/install-poetry@v1
       with:
         virtualenvs-create: true
         virtualenvs-in-project: true
     - name: cache deps
       id: cache-deps
-      uses: actions/cache@v3
+      uses: actions/cache@v4
       with:
         path: simulator/.venv
         key: pydeps-${{ hashFiles('**/poetry.lock') }}
@@ -60,7 +60,7 @@ jobs:
       working-directory: ./simulator
       run: ${{matrix.POETRY_FOLDER}}/bin/poetry run ${{matrix.CMD_BUILD}}
     - name: Upload artifact
-      uses: actions/upload-artifact@v1.0.0
+      uses: actions/upload-artifact@v4
       with:
         name: ledeffect-simulator_${{matrix.TARGET}}
         path: simulator/dist/${{matrix.OUT_FILE_NAME}}

diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -23,7 +23,7 @@ jobs:
     - name: Output Release URL File
       run: echo "${{ steps.create_release.outputs.upload_url }}" > release_url.txt
     - name: Save Release URL File for publish
-      uses: actions/upload-artifact@v1
+      uses: actions/upload-artifact@v4
       with:
         name: release_url
         path: release_url.txt
@@ -50,23 +50,23 @@ jobs:
             ASSET_MIME: application/vnd.microsoft.portable-executable
             POETRY_FOLDER: C:\Users\runneradmin\.local
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v4
     - name: Set up Python 3.9
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: 3.9
     #- name: cache poetry install
     #  uses: actions/cache@v3
     #  with:
     #    path: ${{matrix.POETRY_FOLDER}}
     #    key: poetry-1.3.3-0
-    - uses: snok/install-poetry@v1.3.3
+    - uses: snok/install-poetry@v1
       with:
         virtualenvs-create: true
         virtualenvs-in-project: true
     - name: cache deps
       id: cache-deps
-      uses: actions/cache@v3
+      uses: actions/cache@v4
       with:
         path: simulator/.venv
         key: pydeps-${{ hashFiles('**/poetry.lock') }}
@@ -82,14 +82,14 @@ jobs:
       working-directory: ./simulator
       run: ${{matrix.POETRY_FOLDER}}/bin/poetry run ${{matrix.CMD_BUILD}}
     - name: Load Release URL File from release job
-      uses: actions/download-artifact@v1
+      uses: actions/download-artifact@v4
       with:
         name: release_url
     - name: Get Release File Name & Upload URL
       id: get_release_info
       shell: bash
       run: |
-        value=`cat release_url/release_url.txt`
+        value=`cat release_url.txt`
         echo ::set-output name=upload_url::$value
     - name: Upload Release Asset
       id: upload-release-asset

diff --git a/README.md b/README.md
@@ -18,21 +18,75 @@ And this one (in french) from Tom's Basement:
 [![Klipper LED EFFECTS : C'est Noël avant l'heure dans votre imprimante 3D ! (Tuto Leds)](http://i3.ytimg.com/vi/6rGjlBjFhss/hqdefault.jpg)](https://www.youtube.com/watch?v=6rGjlBjFhss)
 
 ## Disclaimer
-**This is work in progress and currently in "alpha" state.**
+**This is work in progress and currently in "beta" state.**
+I don't take any responsibility for any damage that happens while using this software.
 
-If you encounter any problems, feel free to open an issue.
+## Support
+
+For questions and support use the Q&A section on the [Discussions](https://github.com/julianschill/klipper-led_effect/discussions) page.
+
+If you found a bug or you want to file a feature request open an [issue](https://github.com/julianschill/klipper-led_effect/issues).
 
-If you need support or want to help by testing or contributing, please contact me on the [Klipper](https://discord.klipper3d.org/) or [Voron](https://discord.com/channels/460117602945990666/460172848565190667) Discord: Hagbard#7867
+If you need direct support or want to help by testing or contributing, please contact me on the [Klipper](https://discord.klipper3d.org/) or [Voron](https://discord.gg/voron) Discord. User: 5hagbard23
 
 ## Installation
 
+### Automatic installation
+
 The module can be installed into a existing Klipper installation with an install script. 
 
     cd ~
     git clone https://github.com/LynxCrew/klipper-led_effect.git
     cd klipper-led_effect
     ./install-led_effect.sh
 
+If your directory structure differs from the usual setup you can configure the
+installation script with parameters:
+    ./install-led_effect.sh [-k <klipper path>] [-s <klipper service name>] [-c <configuration path>]
+
+### Manual installation
+Clone the repository:
+    cd ~
+    git clone https://github.com/julianschill/klipper-led_effect.git
+
+Stop Klipper:
+    systemctl stop klipper
+
+Link the file in the Klipper directory (adjust the paths as needed):
+    ln -s klipper-led_effect/led_effect.py ~/klipper/extras/led_effect.py
+
+Start Klipper:
+    systemctl start klipper
+
+Add the updater section to moonraker.conf and restart moonraker to receive 
+updates:
+
+    [update_manager led_effect]
+    type: git_repo
+    path: ~/klipper-led_effect
+    origin: https://github.com/julianschill/klipper-led_effect.git
+    is_system_service: False
+
+## Uninstall
+
+Remove all led_effect definitions in your Klipper configuration and the updater
+section in the Moonraker configuration. Then run the script to remove the link:
+
+    cd ~
+    cd klipper-led_effect
+    ./install-led_effect.sh -u
+
+If your directory structure differs from the usual setup you can configure the
+installation script with parameters:
+    ./install-led_effect.sh -u [-k <klipper path>] [-s <klipper service name>] [-c <configuration path>]
+
+If that fails, you can delete the link in Klipper manually:
+    rm ~/klipper/extras/led_effect.py
+
+Delete the repository (optional)
+    cd ~
+    rm -rf klipper-led_effect
+
 ## Configuration
 
 Documentation can be found [here](docs/LED_Effect.md).