Skip to content

Commit 737dc15

Browse files
Lord-GreyPaulchen-Panther
Lord-Grey
and
Paulchen-Panther
authored
Version 2.1 updates (#30)
* Create dependabot.yml * Update Effect API to Effect Dev. Framework * Remove outdated API documentation * Add configuration export & import * Revert Effect UI documentation * Remove "moment" library dependency * Correct german changelogs link * Add new HA, Skydimo and ftdi devices * Update supported systems * Ad HD108 LEDs --------- Co-authored-by: Paulchen-Panther <[email protected]>
1 parent 45d418f commit 737dc15

File tree

32 files changed

+334
-227
lines changed

32 files changed

+334
-227
lines changed

‎docs/.vitepress/configs/navbar/de.ts

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@ export const navbar_DE: any = [
3030
text: 'Allgemeines',
3131
items: [
3232
{ text: "Effekt-Erstellung", link: '/de/effects/Effects.md' },
33-
{ text: "Effect Engine API", link: '/de/effects/API.md' },
33+
{ text: "Entwicklungsframework", link: '/de/effects/Functions.md' },
34+
{ text: "Benutzeroberfläche", link: '/de/effects/Ui.md' },
3435
{ text: "Unser erster Effekt", link: '/de/effects/OurFirstEffect.md' }
3536
]
3637
},
@@ -52,6 +53,6 @@ export const navbar_DE: any = [
5253
},
5354
{
5455
text: "Changelogs",
55-
link: 'changelogs/index.md'
56+
link: '/de/changelogs/index.md'
5657
}
57-
]
58+
]

‎docs/.vitepress/configs/navbar/en.ts

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,16 +30,11 @@ export const navbar_EN: any = [
3030
text: 'General',
3131
items: [
3232
{ text: "Effect development", link: '/effects/Effects.md' },
33-
{ text: "Effect Engine API", link: '/effects/API.md' },
33+
{ text: "Development Framework", link: '/effects/Functions.md' },
34+
{ text: "Graphical User Interface", link: '/effects/Ui.md' },
3435
{ text: "Our first Effect", link: '/effects/OurFirstEffect.md' }
3536
]
36-
},
37-
{
38-
text: 'Effects UI',
39-
items: [
40-
{ text: "Graphical User Interface", link: '/api/Ui.md' }
41-
]
42-
},
37+
}
4338
]
4439
},
4540
{
@@ -54,4 +49,4 @@ export const navbar_EN: any = [
5449
text: "Changelogs",
5550
link: 'changelogs/index.md'
5651
}
57-
]
52+
]

‎docs/.vitepress/configs/sidebar/de.ts

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ export const sidebar_DE: any = {
1717
items: [
1818
{ text: 'APA102', link: '/de/user/leddevices/spi_pwm/apa102.md' },
1919
{ text: 'APA104', link: '/de/user/leddevices/spi_pwm/apa104.md' },
20+
{ text: 'HD108', link: '/de/user/leddevices/spi_pwm/hd108.md' },
2021
{ text: 'LPD6803', link: '/de/user/leddevices/spi_pwm/lpd6803.md' },
2122
{ text: 'LPD8806', link: '/de/user/leddevices/spi_pwm/lpd8806.md' },
2223
{ text: 'P9813', link: '/de/user/leddevices/spi_pwm/p9813.md' },
@@ -41,20 +42,32 @@ export const sidebar_DE: any = {
4142
{ text: 'Multi-Lightpack', link: '/de/user/leddevices/usb/multilightpack.md' },
4243
{ text: 'Paintpack', link: '/de/user/leddevices/usb/paintpack.md' },
4344
{ text: 'RawHID', link: '/de/user/leddevices/usb/rawhid.md' },
45+
{ text: 'Skydimo', link: '/de/user/leddevices/usb/skydimo.md' },
4446
{ text: 'SEDU', link: '/de/user/leddevices/usb/sedu.md' },
4547
{ text: 'TPM2', link: '/de/user/leddevices/usb/tpm2.md' }
4648
]
4749
},
50+
{
51+
text: 'FTDI',
52+
collapsed: true,
53+
items: [
54+
{ text: 'APA102', link: '/de/user/leddevices/ftdi/apa102.md' },
55+
{ text: 'SK6812', link: '/de/user/leddevices/fdti/sk6812.md' },
56+
{ text: 'WS2812', link: '/de/user/leddevices/ftdi/ws2812.md' }
57+
]
58+
},
4859
{
4960
text: 'Netzwerk',
5061
collapsed: true,
5162
items: [
5263
{ text: 'AtmoOrb', link: '/de/user/leddevices/network/atmoorb.md' },
5364
{ text: 'Cololight', link: '/de/user/leddevices/network/cololight.md' },
5465
{ text: 'FadeCandy', link: '/de/user/leddevices/network/fadecandy.md' },
66+
{ text: 'HomeAssistant', link: '/de/user/leddevices/network/homeassistant.md' },
5567
{ text: 'Nanoleaf', link: '/de/user/leddevices/network/nanoleaf.md' },
5668
{ text: 'Philips Hue', link: '/de/user/leddevices/network/philipshue.md' },
5769
{ text: 'Razer Chroma', link: '/de/user/leddevices/network/razer.md' },
70+
5871
{ text: 'Tinkerforge', link: '/de/user/leddevices/network/tinkerforge.md' },
5972
{ text: 'TPM2.NET', link: '/de/user/leddevices/network/tpm2net.md' },
6073
{ text: 'UDP ArtNet', link: '/de/user/leddevices/network/udpartnet.md' },
@@ -93,15 +106,10 @@ export const sidebar_DE: any = {
93106
text: 'Allgemeines',
94107
items: [
95108
{ text: "Effekt-Erstellung", link: '/de/effects/Effects.md' },
96-
{ text: "Effect Engine API", link: '/de/effects/API.md' },
109+
{ text: "Entwicklungsframework", link: '/de/effects/Functions.md' },
110+
{ text: "Benutzeroberfläche", link: '/de/effects/Ui.md' },
97111
{ text: "Unser erster Effekt", link: '/de/effects/OurFirstEffect.md' }
98112
]
99-
},
100-
{
101-
text: 'Effekt UI',
102-
items: [
103-
{ text: "Grafische Benutzeroberfläche", link: '/de/api/Ui.md' }
104-
]
105113
}
106114
]
107-
}
115+
}

‎docs/.vitepress/configs/sidebar/en.ts

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ export const sidebar_EN: any = {
1717
items: [
1818
{ text: 'APA102', link: '/user/leddevices/spi_pwm/apa102.md' },
1919
{ text: 'APA104', link: '/user/leddevices/spi_pwm/apa104.md' },
20+
{ text: 'HD108', link: '/user/leddevices/spi_pwm/hd108.md' },
2021
{ text: 'LPD6803', link: '/user/leddevices/spi_pwm/lpd6803.md' },
2122
{ text: 'LPD8806', link: '/user/leddevices/spi_pwm/lpd8806.md' },
2223
{ text: 'P9813', link: '/user/leddevices/spi_pwm/p9813.md' },
@@ -42,16 +43,27 @@ export const sidebar_EN: any = {
4243
{ text: 'Paintpack', link: '/user/leddevices/usb/paintpack.md' },
4344
{ text: 'RawHID', link: '/user/leddevices/usb/rawhid.md' },
4445
{ text: 'SEDU', link: '/user/leddevices/usb/sedu.md' },
46+
{ text: 'Skydimo', link: '/user/leddevices/usb/skydimo.md' },
4547
{ text: 'TPM2', link: '/user/leddevices/usb/tpm2.md' }
4648
]
4749
},
50+
{
51+
text: 'FTDI',
52+
collapsed: true,
53+
items: [
54+
{ text: 'APA102', link: '/user/leddevices/ftdi/apa102.md' },
55+
{ text: 'SK6812', link: '/user/leddevices/fdti/sk6812.md' },
56+
{ text: 'WS2812', link: '/user/leddevices/ftdi/ws2812.md' }
57+
]
58+
},
4859
{
4960
text: 'Network',
5061
collapsed: true,
5162
items: [
5263
{ text: 'AtmoOrb', link: '/user/leddevices/network/atmoorb.md' },
5364
{ text: 'Cololight', link: '/user/leddevices/network/cololight.md' },
5465
{ text: 'FadeCandy', link: '/user/leddevices/network/fadecandy.md' },
66+
{ text: 'HomeAssistant', link: '/user/leddevices/network/homeassistant.md' },
5567
{ text: 'Nanoleaf', link: '/user/leddevices/network/nanoleaf.md' },
5668
{ text: 'Philips Hue', link: '/user/leddevices/network/philipshue.md' },
5769
{ text: 'Razer Chroma', link: '/user/leddevices/network/razer.md' },
@@ -93,15 +105,10 @@ export const sidebar_EN: any = {
93105
text: 'Effects',
94106
items: [
95107
{ text: "Effect development", link: '/effects/Effects.md' },
96-
{ text: "Effect Engine API", link: '/effects/API.md' },
108+
{ text: "Development Framework", link: '/effects/Functions.md' },
109+
{ text: "Graphical User Interface", link: '/effects/Ui.md' },
97110
{ text: "Our first Effect", link: '/effects/OurFirstEffect.md' }
98111
]
99-
},
100-
{
101-
text: 'Effects UI',
102-
items: [
103-
{ text: "Graphical User Interface", link: '/api/Ui.md' }
104-
]
105112
}
106113
]
107-
}
114+
}

‎docs/.vitepress/theme/components/Annoucement.vue

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@
1717
<script setup lang="ts">
1818
import { useData } from 'vitepress';
1919
import { computed, onMounted, ref } from 'vue';
20-
import moment from 'moment';
2120
2221
const { frontmatter } = useData();
2322
const newVersionAvailable = ref<boolean>(false);
@@ -31,11 +30,16 @@ async function initialize() {
3130
}
3231
3332
// @ts-expect-error
34-
var publishedDate = latestReleaseInfo.published_at;
35-
if(typeof publishedDate !== 'undefined') {
36-
var publishedSince = moment().diff(moment(publishedDate), 'days');
37-
if(publishedSince <= expiringDays.value) {
38-
// @ts-expect-error
33+
const publishedDate = latestReleaseInfo.published_at;
34+
if (typeof publishedDate !== 'undefined') {
35+
const published = new Date(publishedDate);
36+
const now = new Date();
37+
38+
const millisecondsInDay = 1000 * 60 * 60 * 24;
39+
const diffInDays = Math.floor((now.getTime() - published.getTime()) / millisecondsInDay);
40+
41+
if (diffInDays <= expiringDays.value) {
42+
// @ts-expect-error
3943
newVersionTag.value = latestReleaseInfo.tag_name;
4044
newVersionAvailable.value = true;
4145
}

‎docs/api/Detect.md

Lines changed: 0 additions & 60 deletions
This file was deleted.

‎docs/api/Guidelines.md

Lines changed: 0 additions & 21 deletions
This file was deleted.

‎docs/de/api/Detect.md

Lines changed: 0 additions & 55 deletions
This file was deleted.

‎docs/de/api/Guidelines.md

Lines changed: 0 additions & 21 deletions
This file was deleted.

‎docs/de/effects/Effects.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Effekt-Erstellung
2-
Hyperion bietet eine leistungsfähige API, um eigene Effekte zu erstellen, zusammen mit den möglichen Optionen und der Benutzeroberfläche, um diese anzupassen.
2+
Mit Hyperion steht Ihnen ein leistungsfähiges Framework für die Entwicklung eigener Effekte zur Verfügung. Es bietet die Möglichkeit, Effekte zusammen mit möglichen Optionen und einer optimierten Benutzeroberfläche zu erstellen.
33

44
## Effekt-Dateien
55
Ein Effekt hat 3 verschiedene Dateien.
66
| Datei | Sprache | Bemerkung |
77
| :-------------------- | :------------------------------------ | :----------------------------------------------------------------------------------------------------------------------------- |
88
| neweffect.py | [Python](https://www.python.org) | Das Herzstück des Effekts |
99
| neweffect.json | [JSON](https://www.json.org) | Enthält Optionen für die Python-Datei, die dafür sorgen, dass sie konfigurierbar ist. |
10-
| neweffect.schema.json | [JSON Schema](https://json-schema.org) | Erzeugt die Bedienoberfläche für die Optionen und wird zur Überprüfung von Benutzereingaben verwendet. [Read more](/de/api/Ui.md) |
10+
| neweffect.schema.json | [JSON Schema](https://json-schema.org) | Erzeugt die Bedienoberfläche für die Optionen und wird zur Überprüfung von Benutzereingaben verwendet. [Read more](/de/effects/Ui.md) |

0 commit comments

Comments
 (0)