From c81e5ebcc5d8f8732ee5e56cc31ad80a1cfdfdb4 Mon Sep 17 00:00:00 2001 From: Taylor Date: Tue, 17 Sep 2024 00:51:25 +0000 Subject: [PATCH] Update README.md Update README in anticipation of initial upload --- README.md | 31 +++++++++++++++++++++++++++++-- 1 file changed, 29 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 98cd78b..1f53747 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,30 @@ -# lamp_control +# Lamp Control -A simple Arduino program to act as a simple PWM controller, supporting a rotary encoder (with button) to control power and brightness. \ No newline at end of file +A simple Arduino program to act as a simple PWM controller, supporting a rotary encoder (with button) to control power and brightness. + +## Setup + +(Images coming soon!) + +This project requires the following supporting hardware; + +- Arduino (I tend to use the Pro Mini in lamps, as they are incredibly compact and fit easily inside projects) +- RFP30N06LE MOSFET (I like the ones that include a PCB) +- EC11 Rotary Encoder +- LEDs (strip, panel, individual, your choice) +- DC Power Supply (note you'll probably want a buck converter if your supply is more than +5V) +- (optional) Buck Converter (if using a power supply >5V) +- (optional) DC barrel jack + +Assembled correctly, the above parts paired with the included code, \*edited to ensure the pin definitions are the same as the pins wired to hardware, should create a lamp that is easy to use with simple, responsive control. + +## Features + +- Easy to assemble, easy to modify code (to support assembly in any orientation) +- Fine-grained brightness control, tapering on and off near minimum and maximum brightness +- Push-button on/off control +- Supports LEDs of any voltage (when using a buck converter on your Arduino) + +## Notes + +Code is sloppy as hell and really needs some re-working with regards to button functionality (as it currently relies on EZButton and additional dependencies are annoying as hell IMO) \ No newline at end of file