Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
alexandrelamberty committed Sep 22, 2022
0 parents commit 3960be8
Show file tree
Hide file tree
Showing 3 changed files with 737 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.vscode
66 changes: 66 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
# Sentinel

Home monitoring system running on a NodeMCU ESP8266 ESP-12F.

The idea behind this project his to have a base system working on a standard
microcontroller with communication capabilities.

See the [Nidus](https://github.com/alexandrelamberty/nidus/) repository and the
[Sentinel Api Spec](https://github.com/alexandrelamberty/sentinel-api)

## Features

- [ ] Configuration
- [x] Wifi
- [x] Access Point
- [x] Configuration
- [ ] Auto-pairing
- [ ] Auto updates
- [ ] Protocols
- [x] HTTP
- [ ] MQTT
- [ ] Sensors
- [x] BMP180
- [ ] Security

## Hardware

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]().

## Installation

### Arduino

Open the Arduino Preferences <kbd>Ctrl</kbd>+<kbd>,</kbd> and in `Additional
Boards Manager Urls`
add the following one:
```
https://arduino.esp8266.com/stable/package_esp8266com_index.json
```

Open the Arduino Library Manager <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>I</kbd>
and install the following packages:

- ArduinoJson
- ArduinoMqttClient
- [BMP180_Breakout_Arduino_Library](https://github.com/sparkfun/BMP180_Breakout_Arduino_Library)
- WiFiManager

Upload the sketch


## Configuration

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
the setup.

The device then will restart and will pair automatically with the server.

Loading

0 comments on commit 3960be8

Please sign in to comment.