Skip to content

Latest commit

 

History

History
32 lines (21 loc) · 1.93 KB

README.md

File metadata and controls

32 lines (21 loc) · 1.93 KB
Raw

Familamps

Installation

  • This library expects MicroPython installed on your microcontroller. For a guide for ESP32 boards, see Getting started with MicroPython on the ESP32
  • Rename env.json.example to env.json and include your local WiFi details for the initial library configuration. If you have your database's api key, you can add it here now as well.
  • Update all of the constants in constants.py to reflect your GPIO pins, number of leds, and capacitive touch threshold (see below for this value)
  • Upload the repository to each of your microcontrollers and run configure.py to install MicroWifiManager for fast, intuitive WiFi configuration on deployed boards (from here, your WiFi credentials are no longer needed if you want to remove them from the board).
  • In MicroPython, main.py runs automatically when the microcontroller is power on. The light will look for an update every 10 seconds by default and if the capacitive touch threshold is passed, will post an updated.
    • Alternatively there's a second main file that hosts a color picker at the device's IP address on your home network and allows for color control.

Capacitive Touch Threshold

Your capacitive touch values will vary based on a number of factors, so it's best to measure these yourself. To do this, you can run the following script while touching and untouching your capacitive area and monitoring the output:

from machine import TouchPad, Pin
from constants import TOUCH_PIN

touchPin = TouchPad(Pin(TOUCH_PIN))

while True:
  print(touchPin.read())

On a configure light, you can also run calibrate.py which will change the light to white while getting an initial reading and then yellow when it's ready for you to touch and hold the capacitive area. When it changes back to white, the reading is finished

> python calibrate.py