Skip to content

Commit

Permalink
README polish
Browse files Browse the repository at this point in the history
  • Loading branch information
bitmagier committed Aug 29, 2024
1 parent f39751e commit d99fe2d
Show file tree
Hide file tree
Showing 6 changed files with 25 additions and 21 deletions.
30 changes: 17 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,17 @@
A smart light bar — illuminates dark places on-demand by gently powering-up/down a LED stripe depending on the ambient light level and a detected human presence.

Hardware core is a ESP32-H2 SoC connected with an VEML7700 ambient light sensor and a small but effective LD2410 radar based presence sensor.
This automatic floor light is completely self-contained.
This automatic light is completely self-contained - just needs a 12V power supply.

_It does not use Wifi or Zigbee features of the ESP32-H2 SoC and does not connect to a smart home system with that firmware here - but one may add such a feature smoothly, of course._

Status:
- Software: ready, tested
- Hardware: ready, tested
- Software: tested, ready
- Hardware: tested, ready

## Sketch

<a>
<img src="hardware/pictures/light_bar_sketch.png" alt="Light bar sketch" width="600">
<img src="hardware/pictures/light_bar_final.png" alt="Light bar sketch" width="800">
</a>

## Hardware
Expand Down Expand Up @@ -70,11 +69,6 @@ Please note:
- 4 Pin Connector Plug + Cable
- On/Off Switch

### References

- [Transistors](http://stefanfrings.de/transistoren/index.html)
- [Switching with transistors](https://dl6gl.de/schalten-mit-transistoren.html)

## Software

Complete program code is included here. In order to build it and flash the ESP32-H2 we need a ESP32 Rust embedded toolchain.
Expand All @@ -94,12 +88,22 @@ For that and this project we need:
- Monitor chip terminal output: `espflash monitor`


## References

- [Transistors](http://stefanfrings.de/transistoren/index.html)
- [Switching with transistors](https://dl6gl.de/schalten-mit-transistoren.html)
- [The Rust on ESP Book - Setting Up a Development Environment](https://esp-rs.github.io/book/installation/index.html)


## Terms & Conditions
Feel free to use anything here for learning, building your own version or make a product out of it and sell it.
Have fun!

Pull requests are welcome.
Bug reports & pull requests are welcome.

_bitmagier, August 2024_


In case you find it useful, the author would be delighted to notice a small donation in [Solana](https://solana.com/) to his wallet: `FTMfeKYhpVAouuwXjpJXhnT13fkeNJqQsRGMBxBo1GML`.
_In case you find it useful, I would be delighted to notice a small donation to my Solana wallet: `FTMfeKYhpVAouuwXjpJXhnT13fkeNJqQsRGMBxBo1GML`_

_bitmagier, August 2024_
![QR Code](./hardware/pictures/solana_wallet.png).
Binary file added hardware/pictures/light_bar_final.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 hardware/pictures/solana_wallet.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 6 additions & 6 deletions hardware/wiring_diagram.drawio
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<mxfile host="Electron" modified="2024-08-25T20:42:04.514Z" agent="Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/24.6.4 Chrome/124.0.6367.207 Electron/30.0.6 Safari/537.36" etag="1eOFapcIbvahClR06pGO" version="24.6.4" type="device">
<mxfile host="Electron" modified="2024-08-29T17:04:32.122Z" agent="Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/24.6.4 Chrome/124.0.6367.207 Electron/30.0.6 Safari/537.36" etag="au6CIzHIoQqk-d83SjoS" version="24.6.4" type="device">
<diagram name="Page-1" id="7e0a89b8-554c-2b80-1dc8-d5c74ca68de4">
<mxGraphModel dx="1434" dy="835" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="1169" pageHeight="827" background="none" math="0" shadow="0">
<root>
Expand Down Expand Up @@ -684,8 +684,8 @@
<mxPoint x="762" y="782" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="4W4AlC_sW6kBnJiuT3F1-32" value="PWM&lt;br&gt;(inverted)" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];fontSize=10;fontColor=#FF9933;" parent="1" vertex="1" connectable="0">
<mxGeometry x="956.9995999997994" y="577.4599799790001" as="geometry" />
<mxCell id="4W4AlC_sW6kBnJiuT3F1-32" value="PWM signal (inverted)" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];fontSize=10;fontColor=#FF9933;" parent="1" vertex="1" connectable="0">
<mxGeometry x="966.9995999997994" y="581.999979979" as="geometry" />
</mxCell>
<mxCell id="iJFj2JviCjap6J0s-o93-5" value="" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;fillColor=#1ba1e2;strokeColor=#006EAF;endArrow=none;endFill=0;" parent="1" source="t9Yk8rtrzWxuMsd4z5qw-52" edge="1">
<mxGeometry relative="1" as="geometry">
Expand Down Expand Up @@ -752,7 +752,7 @@
</Array>
</mxGeometry>
</mxCell>
<mxCell id="MiJf-mNnC2e54M0besiX-1" value="Presence Sensor Power (12V switched)" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];" vertex="1" connectable="0" parent="2iyte8KJNzoHr3Z_swD4-38">
<mxCell id="MiJf-mNnC2e54M0besiX-1" value="Presence sensor power (12V switched)" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];fontSize=10;" parent="2iyte8KJNzoHr3Z_swD4-38" vertex="1" connectable="0">
<mxGeometry x="-0.409" y="-2" relative="1" as="geometry">
<mxPoint x="-48" y="-10" as="offset" />
</mxGeometry>
Expand Down Expand Up @@ -791,7 +791,7 @@
</Array>
</mxGeometry>
</mxCell>
<mxCell id="Gl8Fd9Fw2VBkpcaN648f-11" value="Presence Sensor Power switch" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];fontFamily=Helvetica;fontSize=11;fontColor=default;labelBackgroundColor=default;rotation=270;" parent="Gl8Fd9Fw2VBkpcaN648f-10" vertex="1" connectable="0">
<mxCell id="Gl8Fd9Fw2VBkpcaN648f-11" value="Presence Sensor Power switch" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];fontFamily=Helvetica;fontSize=10;fontColor=default;labelBackgroundColor=default;rotation=270;" parent="Gl8Fd9Fw2VBkpcaN648f-10" vertex="1" connectable="0">
<mxGeometry x="-0.0098" y="-1" relative="1" as="geometry">
<mxPoint x="-8" y="54" as="offset" />
</mxGeometry>
Expand Down Expand Up @@ -838,7 +838,7 @@
<mxCell id="Gl8Fd9Fw2VBkpcaN648f-20" value="" style="shape=waypoint;sketch=0;fillStyle=solid;size=6;pointerEvents=1;points=[];fillColor=#1ba1e2;resizable=0;rotatable=0;perimeter=centerPerimeter;snapToPoint=1;fontColor=#ffffff;strokeColor=#006EAF;" parent="1" vertex="1">
<mxGeometry x="1097" y="772" width="20" height="20" as="geometry" />
</mxCell>
<mxCell id="Y1uZ7bmz27FLlu9ukU51-5" value="Sensor Light&lt;br&gt;Wiring Diagram&lt;br&gt;v1.1.1" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" parent="1" vertex="1">
<mxCell id="Y1uZ7bmz27FLlu9ukU51-5" value="Sensor Light&lt;br&gt;Wiring Diagram&lt;br&gt;v1.1.2" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" parent="1" vertex="1">
<mxGeometry x="28.99" y="782" width="91.01" height="40" as="geometry" />
</mxCell>
<mxCell id="q0wGzRVEdxRFVfAUd2rx-1" value="Diode" style="pointerEvents=1;fillColor=strokeColor;verticalLabelPosition=middle;shadow=0;dashed=0;align=right;html=1;verticalAlign=middle;shape=mxgraph.electrical.diodes.diode;direction=south;fontSize=10;labelPosition=left;" parent="1" vertex="1">
Expand Down
2 changes: 1 addition & 1 deletion hardware/wiring_diagram_dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion hardware/wiring_diagram_light.svg
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 d99fe2d

Please sign in to comment.