mirror of
https://github.com/0x1d/esp8266-laser.git
synced 2026-03-22 09:04:15 +01:00
fancypants md
This commit is contained in:
14
README.md
14
README.md
@@ -1,7 +1,7 @@
|
|||||||
# Esp8266-Laser
|
# Esp8266-Laser
|
||||||
Wifi Host for the Arduino-Laser-Spirograph
|
Wifi Host for the Arduino-Laser-Spirograph
|
||||||
|
|
||||||
# HTTP endpoints:
|
## HTTP endpoints:
|
||||||
* /spirograph
|
* /spirograph
|
||||||
* **GET** returns laser and motor values (0 at startup)
|
* **GET** returns laser and motor values (0 at startup)
|
||||||
* **POST** sets new value(s)
|
* **POST** sets new value(s)
|
||||||
@@ -33,7 +33,7 @@ Wifi Host for the Arduino-Laser-Spirograph
|
|||||||
* **GET** returns /presets.json
|
* **GET** returns /presets.json
|
||||||
|
|
||||||
|
|
||||||
# Install
|
## Install
|
||||||
- install arduino ide (1.8.5) or PlatformIO (see Development section for further instructions)
|
- install arduino ide (1.8.5) or PlatformIO (see Development section for further instructions)
|
||||||
|
|
||||||
- follow this instruction
|
- follow this instruction
|
||||||
@@ -53,8 +53,8 @@ You may also need to:
|
|||||||
- get and install driver for nodemcu
|
- get and install driver for nodemcu
|
||||||
https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers
|
https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers
|
||||||
|
|
||||||
# Development
|
## Development
|
||||||
PlatformIO
|
### PlatformIO
|
||||||
----------
|
----------
|
||||||
The project is intended to run on PlatformIO and the build environment is configured for NodeMCU 0.9 (ESP-12 Module).
|
The project is intended to run on PlatformIO and the build environment is configured for NodeMCU 0.9 (ESP-12 Module).
|
||||||
More informations: http://docs.platformio.org/en/latest/platforms/espressif8266.html
|
More informations: http://docs.platformio.org/en/latest/platforms/espressif8266.html
|
||||||
@@ -90,16 +90,16 @@ build:firmware
|
|||||||
upload:firmware
|
upload:firmware
|
||||||
```
|
```
|
||||||
|
|
||||||
Frontend
|
### Frontend
|
||||||
--------
|
--------
|
||||||
Frontend development requires NodeJS / npm.
|
Frontend development requires NodeJS / npm.
|
||||||
The development server watches all files in the frontend directory and automatically builds and copies the frontend code to the data folder.
|
The development server watches all files in the frontend directory and automatically builds and copies the frontend code to the data folder.
|
||||||
|
|
||||||
```
|
```
|
||||||
# run development server on port 8080
|
### run development server on port 8080
|
||||||
npm run dev
|
npm run dev
|
||||||
|
|
||||||
# build distribution source to data folder
|
### build distribution source to data folder
|
||||||
npm run build
|
npm run build
|
||||||
```
|
```
|
||||||
|
|
||||||
Reference in New Issue
Block a user