docs: add reference to erfamap incl. example usage
This commit is contained in:
parent
02ef61c54b
commit
9d90adcd31
1 changed files with 8 additions and 7 deletions
15
README.md
15
README.md
|
@ -4,20 +4,19 @@ A map of hackerspaces lasercut from plywood, with their [SpaceAPI][spaceapi] ope
|
||||||
|
|
||||||
The LEDs are WS2812-compatible bulb-shaped LEDs, and they are controlled by an ESP32-C3 board.
|
The LEDs are WS2812-compatible bulb-shaped LEDs, and they are controlled by an ESP32-C3 board.
|
||||||
|
|
||||||
This is a work in progress (2nd half 2024) project; documentation will be updated as the project progresses.
|
|
||||||
|
|
||||||
![The finished map shown from the front](images/spaceapimap_front.jpg)
|
![The finished map shown from the front](images/spaceapimap_front.jpg)
|
||||||
![The finished map shown from the back, showing the wiring](images/spaceapimap_back.jpg)
|
![The finished map shown from the back, showing the wiring](images/spaceapimap_back.jpg)
|
||||||
|
|
||||||
|
|
||||||
## Contents of This Repository
|
## Contents of This Repository
|
||||||
|
|
||||||
### erfamap-output/
|
### erfamap-output/
|
||||||
|
|
||||||
The data for lasercutting the map was generated using a modified
|
The data for lasercutting the map was generated using a modified
|
||||||
version of my [Erfamap][erfamap] project, which uses the
|
version of my [Erfamap][erfamap] project, which uses the SpaceAPI
|
||||||
[api.spaceapi.io][api.spaceapi.io] SpaceAPI aggregator instead of the
|
directory instead of the CCC internal Wiki to determine which dots to
|
||||||
CCC internal Wiki to determine which dots to place where. A lot of
|
place where. A lot of this data was edited by hand in order to
|
||||||
this data was edited by hand in order to improve it for laser cutting.
|
improve it for laser cutting.
|
||||||
|
|
||||||
- `spaceapi-info.json` is the cache file used by the modified script.
|
- `spaceapi-info.json` is the cache file used by the modified script.
|
||||||
It has been edited manually to remove some entries which had broken
|
It has been edited manually to remove some entries which had broken
|
||||||
|
@ -28,7 +27,9 @@ this data was edited by hand in order to improve it for laser cutting.
|
||||||
- Text has been converted to paths.
|
- Text has been converted to paths.
|
||||||
- All paths have been assigned to layers corresponding to how they should be processed.
|
- All paths have been assigned to layers corresponding to how they should be processed.
|
||||||
|
|
||||||
The modified Erfamap script will be released at a later point after some further cleanup.
|
The modified Erfamap script is available on the [`spaceapimap` branch of the erfamap repository](https://git.kabelsalat.ch/s3lph/erfamap/src/branch/spaceapimap). Unfortunately, I did not preserve the command used to generate this exact map, but here's an example to get you started:
|
||||||
|
|
||||||
|
./generate_map.py --erfa-source spaceapi --long-edge 700 --bbox 3.5 45 15 55 --dotsize-erfa 4.75 --dotsize-chaostreff 4.75 --stylesheet laser.css
|
||||||
|
|
||||||
### pcb/
|
### pcb/
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue