docs: add license
This commit is contained in:
parent
9636b6e53c
commit
ca695eff21
3 changed files with 47 additions and 1 deletions
21
LICENSE
Normal file
21
LICENSE
Normal file
|
@ -0,0 +1,21 @@
|
||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2024 s3lph
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software 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.
|
21
README.md
21
README.md
|
@ -36,7 +36,7 @@ form a single WS2812 chain. There are 83 LEDs in the current version, so a tota
|
||||||
The ESP32-C3 needs to be soldered to the first PCB.
|
The ESP32-C3 needs to be soldered to the first PCB.
|
||||||
|
|
||||||
> :warning: **There is a small issue with V1.0 of the PCB!** (Please check the version number on the silk screen!):
|
> :warning: **There is a small issue with V1.0 of the PCB!** (Please check the version number on the silk screen!):
|
||||||
>
|
>
|
||||||
> Pins 1 and 4 of the OUT pin header are swapped - this can be easily worked around by swapping wires number 1 and 4 in the JST connector plugged into this header.
|
> Pins 1 and 4 of the OUT pin header are swapped - this can be easily worked around by swapping wires number 1 and 4 in the JST connector plugged into this header.
|
||||||
|
|
||||||
### esp32/
|
### esp32/
|
||||||
|
@ -54,6 +54,12 @@ The PlatformIO Arduino project for the ESP32. It perfoms the following tasks:
|
||||||
The list of SpaceAPI endpoints to display is defined in `esp32/src/spacemap.h`.
|
The list of SpaceAPI endpoints to display is defined in `esp32/src/spacemap.h`.
|
||||||
The position of an endpoint in the `spaces` array corresponds to the index of the WS2812 LED it controls.
|
The position of an endpoint in the `spaces` array corresponds to the index of the WS2812 LED it controls.
|
||||||
|
|
||||||
|
To compile and upload the code to the ESP32, use PlatformIO:
|
||||||
|
|
||||||
|
```shell-session
|
||||||
|
pio run -t upload
|
||||||
|
```
|
||||||
|
|
||||||
### led_plugging_tool/
|
### led_plugging_tool/
|
||||||
|
|
||||||
A 3D-printable tool that helps with cutting the LED legs to size and attach them to JST ZH-4 connectors the correct way.
|
A 3D-printable tool that helps with cutting the LED legs to size and attach them to JST ZH-4 connectors the correct way.
|
||||||
|
@ -77,7 +83,20 @@ Usage:
|
||||||
- ESP32-C3 Super Mini: https://de.aliexpress.com/item/1005006252882434.html
|
- ESP32-C3 Super Mini: https://de.aliexpress.com/item/1005006252882434.html
|
||||||
- JST-ZH cables: https://de.aliexpress.com/item/1005007298855435.html (4P, Reversed)
|
- JST-ZH cables: https://de.aliexpress.com/item/1005007298855435.html (4P, Reversed)
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
Unless otherwise noted, the contents of this repository are licensed under the MIT License (See LICENSE).
|
||||||
|
|
||||||
|
### Public Domain Data
|
||||||
|
|
||||||
|
I consider the contents of `erfamap-output/` and `esp32/src/spacemap.h` to be in the public domain.
|
||||||
|
|
||||||
|
If they are not, I license these under the Creative Commons [CC0 1.0][cc0] "No Rights Reserved" license.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
[spaceapi]: https://spaceapi.io
|
[spaceapi]: https://spaceapi.io
|
||||||
[erfamap]: https://git.kabelsalat.ch/s3lph/erfamap
|
[erfamap]: https://git.kabelsalat.ch/s3lph/erfamap
|
||||||
[api.spaceapi.io]: https://api.spaceapi.io/
|
[api.spaceapi.io]: https://api.spaceapi.io/
|
||||||
|
[cc0]: https://creativecommons.org/publicdomain/zero/1.0/
|
||||||
|
|
|
@ -1,4 +1,10 @@
|
||||||
|
|
||||||
|
/*
|
||||||
|
* CC0: This work (spacemap.h) has been marked as dedicated to the public domain.
|
||||||
|
* https://creativecommons.org/public-domain/cc0/
|
||||||
|
*/
|
||||||
|
|
||||||
|
|
||||||
const char* spaces[] = {
|
const char* spaces[] = {
|
||||||
// 0
|
// 0
|
||||||
"https://www.posttenebraslab.ch/status/status.json",
|
"https://www.posttenebraslab.ch/status/status.json",
|
||||||
|
|
Loading…
Reference in a new issue