diff --git a/.github/workflows/arduino.yaml b/.github/workflows/arduino.yaml index a1b9d10..c76674e 100644 --- a/.github/workflows/arduino.yaml +++ b/.github/workflows/arduino.yaml @@ -28,5 +28,5 @@ jobs: - name: doxygen env: GH_REPO_TOKEN: ${{ secrets.GH_REPO_TOKEN }} - PRETTYNAME: "Sentinel" + PRETTYNAME: "Adafruit SGP30 Arduino Library" run: bash ci/doxy_gen_and_deploy.sh diff --git a/README.md b/README.md index d318641..7e6dee2 100644 --- a/README.md +++ b/README.md @@ -6,14 +6,14 @@ The idea behind this project his to have a base system working on a standard microcontroller with communication capabilities, http/https, mqtt... See the [Nidus](https://github.com/alexandrelamberty/nidus/) repository and the -[Sentinel Api Spec](https://github.com/alexandrelamberty/sentinel-api) +[Sentinel API Spec](https://github.com/alexandrelamberty/sentinel-api) ## Features - [ ] Configuration - - [x] Wifi - - [x] Access Point - - [x] Configuration + - [x] Wifi + - [x] Access Point + - [x] Configuration - [x] Auto-pairing - [ ] Auto updates - [ ] Protocols @@ -34,8 +34,8 @@ See the [Nidus](https://github.com/alexandrelamberty/nidus/) repository and the ## Hardware -The hardware I currently use is a -[NodeMCU Lua Amica Module V2 ESP8266 ESP-12FCP2102]() +The hardware I currently use is a +[NodeMCU Lua Amica Module V2 ESP8266 ESP-12FCP2102]() micro-controller, a temperature sensor [DS18B20]() and temperature and pressure sensor [BMP180](). @@ -43,11 +43,12 @@ pressure sensor [BMP180](). ## Installation -### Arduino +### Arduino Open the Arduino Preferences Ctrl+, and in `Additional Boards Manager Urls` add the following one: + ``` https://arduino.esp8266.com/stable/package_esp8266com_index.json ``` @@ -69,8 +70,7 @@ Connect the device to a power supply. Connect your phone to the new access point created by the device. It should be something like `sentinel-xxx`. -Then access the device settings by navigating to http://192.168.4.1 and complete +Then access the device settings by navigating to and complete the setup. The device then will restart and will pair automatically with the server. -