Skip to content

Commit

Permalink
fixed comments
Browse files Browse the repository at this point in the history
  • Loading branch information
Max McKelvey authored and Max McKelvey committed Aug 21, 2023
1 parent 3765c82 commit d65d815
Show file tree
Hide file tree
Showing 6 changed files with 30 additions and 22 deletions.
8 changes: 3 additions & 5 deletions docs/docs/installation/7-monitoring-notification-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,9 @@ This is the easiest way to deploy your Groundlight detectors on a linux computer

## Prerequisites

1. You must have a linux machine that can run Docker
2. The machine must have internet access
3. You must have an API key for the Groundlight API
4. Either a usb camera/raspberry pi camera must be plugged into your machine, or there must be an rtsp stream available at the url you provide
5. The machine must be able to host a local web server
1. Internet connected linux computer
2. Video source (USB camera or RTSP stream)
3. Groundlight API Key

## Deployment

Expand Down
44 changes: 27 additions & 17 deletions docs/docs/installation/8-nocode-iot-deployment.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# No-Code IoT Deployment

We built a tool for deploying your Groundlight detector on any supported ESP32 Camera Board without writing any code. This tool is available at https://code.groundlight.ai/groundlight-embedded-uploader/.
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

Expand All @@ -20,26 +20,36 @@ The tool supports the following notification options for your deployed detector:

## Multiple Supported Boards

The supported boards are:
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 X [[purchase here](https://shop.m5stack.com/products/esp32-psram-timer-camera-x-ov3660?variant=36362228301988)]
- AI-Thinker ESP32-CAM [[purchase here](https://www.amazon.com/s?k=ESP32-CAM&i=electronics&crid=10JXSSPIN5ZZ1&sprefix=,electronics,340)]
- 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-edgelight
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]).

### Additional Arduino Resources

To learn more about Arduino and expand your knowledge, you can explore the following resources:

- [Arduino Official Website](https://www.arduino.cc/)
- [Arduino Playground](https://playground.arduino.cc/)
- [Arduino Forum](https://forum.arduino.cc/)
- [ESP32 Community Forum](https://www.esp32.com/)
- [Adafruit Learning System](https://learn.adafruit.com/)

These resources provide extensive documentation, tutorials, and community support for Arduino enthusiasts and developers.
Binary file added docs/static/img/esp32-cam.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/static/img/m5stack_timer_camera.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/static/img/m5stack_timer_camera_x.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/static/img/xiao-esp32s3-sense.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d65d815

Please sign in to comment.