-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Maxm/add nocode setup tools to docs (#80)
* new pages * fixed docker deployment instructions * removed comment, added purchase links * renamed detector builder page, added prerequisites * formatting * machine must be linux for the docker setup to work * changed docker compose yaml * renamed to notification-server-example and iot example, moved to installation section * changed notification-server-example to Monitoring Notification Server * removed arduino * fixed links * fixed links again * fixed comments * groundlight ai link --------- Co-authored-by: Max McKelvey <[email protected]> Co-authored-by: Max McKelvey <[email protected]>
- Loading branch information
1 parent
172d24b
commit 9d75819
Showing
10 changed files
with
108 additions
and
31 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
46 changes: 46 additions & 0 deletions
46
docs/docs/installation/7-monitoring-notification-server.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
# Monitoring Notification Server | ||
|
||
This is the easiest way to deploy your Groundlight detectors on a linux computer. All configuration is done through a web user interface, and no code development is required. | ||
|
||
## Prerequisites | ||
|
||
1. Internet connected linux computer | ||
2. Video source (USB camera or RTSP stream) | ||
3. Groundlight API Key (available from [groundlight.ai](https://www.groundlight.ai/)) | ||
|
||
## Deployment | ||
|
||
1. Install Docker on your computer. See [Docker's installation instructions](https://docs.docker.com/get-docker/). | ||
2. Create a new file called `docker-compose.yml` in your project directory. Copy the following into it: | ||
|
||
```yaml | ||
services: | ||
frontend: | ||
image: docker.io/groundlight/monitoring-notification-server-frontend:latest | ||
ports: | ||
- "3000:3000" | ||
depends_on: | ||
- backend | ||
backend: | ||
image: docker.io/groundlight/monitoring-notification-server-backend:latest | ||
ports: | ||
- "8000:8000" | ||
devices: | ||
- /dev/video0:/dev/video0 | ||
- /dev/video1:/dev/video1 | ||
- /dev/video2:/dev/video2 | ||
- /dev/video3:/dev/video3 | ||
privileged: true | ||
volumes: | ||
- /dev/bus/usb:/dev/bus/usb | ||
``` | ||
3. Run the following command in your project directory: | ||
```bash | ||
docker-compose up | ||
``` | ||
|
||
4. If installed locally, open http://localhost:3000 in your browser. If installed on a remote device, replace `localhost` with the IP address of your device. You should see the following page: | ||
|
||
![Screenshot of the Groundlight Monitoring Notification Server](/img/docker-img-frontpage.png) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
# No-Code IoT Deployment | ||
|
||
Groundlight supplies a tool for no-code deployment of a detector to an ESP32 Camera board. You can find it at https://code.groundlight.ai/groundlight-embedded-uploader/. | ||
|
||
## Easy Deployment | ||
|
||
This tool is designed to make it as easy as possible to deploy your Groundlight detector on an ESP32 Camera Board. You can deploy your detector in just a few clicks. | ||
|
||
1. Go to https://code.groundlight.ai/groundlight-embedded-uploader/. | ||
2. Plug your ESP32 Camera Board into your computer with a USB cable. | ||
3. Click through the steps to upload your detector to your ESP32 Camera Board. | ||
|
||
## Notification Options | ||
|
||
The tool supports the following notification options for your deployed detector: | ||
|
||
- SMS (With Twilio) | ||
- Slack | ||
|
||
## Multiple Supported Boards | ||
|
||
Tested with the following boards. Many other ESP32 boards should work as well, but may require building the firmware from source and changing the IO pin definitions. | ||
|
||
- M5Stack ESP32 PSRAM Timer Camera [[purchase here](https://shop.m5stack.com/products/esp32-psram-timer-camera-ov3660)] | ||
- M5Stack ESP32 PSRAM Timer Camera X [[purchase here](https://shop.m5stack.com/products/esp32-psram-timer-camera-x-ov3660)] | ||
- ESP32-CAM [[purchase here](https://www.amazon.com/s?k=ESP32-CAM&i=electronics)] | ||
- SeeedStudio ESP32S3 Sense [[purchase here](https://www.seeedstudio.com/XIAO-ESP32S3-Sense-p-5639.html)] | ||
|
||
<img | ||
src={require('/img/m5stack_timer_camera.png').default} | ||
alt="Example banner" | ||
width={"25%"} | ||
/> | ||
<img | ||
src={require('/img/m5stack_timer_camera_x.png').default} | ||
alt="Example banner" | ||
width={"25%"} | ||
/> | ||
<img | ||
src={require('/img/esp32-cam.png').default} | ||
alt="Example banner" | ||
width={"25%"} | ||
/> | ||
<img | ||
src={require('/img/xiao-esp32s3-sense.png').default} | ||
alt="Example banner" | ||
width={"25%"} | ||
/> | ||
|
||
## Source Code | ||
|
||
The source code is written as an Arduino-based PlatformIO project for ESP32, and is available on GitHub at https://github.com/groundlight/esp32cam | ||
|
||
If you need assistance or have questions about integrating Groundlight with Arduino, please consider opening an issue on the GitHub repository or reaching out to our [support team](mailto:[email protected]). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.