diff --git a/INSTALLER.md b/INSTALLER.md index c3346f4..5efdba0 100644 --- a/INSTALLER.md +++ b/INSTALLER.md @@ -9,3 +9,5 @@ The Nostr Zap Lamp flashes when a relay broadcasts a Nostr event of kind 9735. Y The number of flashes corresponds to the number of digits in the number of sats sent. i.e. 3 sats will result in 1 flash, 152 sats will result in 3 flashes, 1001 sats will result in 4 flashes. [Buy a pre-assembled or complete Zap Lamp kit on the LNbits shop](https://shop.lnbits.com/product/nostr-zap-lamp) + +[View the GitHub repo](https://github.com/lnbits/nostr-zap-lamp) diff --git a/README.md b/README.md index 66a272a..ac46b1e 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ![](https://github.com/lnbits/nostr-zap-lamp/raw/main/img/lamp.jpg) -Get a visual Zap! when someone zaps your or anyone on Nostr. +Get a visual "Zap!"" when someone zaps you or anyone on Nostr. The Nostr Zap Lamp flashes when a relay broadcasts a Nostr event of kind 9735. You can set the lamp to flash zaps sent to a specific npub, or any npub on nostr. @@ -15,7 +15,7 @@ The number of flashes corresponds to the number of digits in the number of sats + Show a signal when a zap is sent to one or all nostr npubs + Background brightness control + Easily configure to use your own nostr relay -+ Easy configuration to work with any npub ++ Simple configuration to work with any npub ## Parts + [LED "Neon" lamp](https://www.amazon.co.uk/YIVIYAR-Lightning-Battery-Bedroom-Christmas/dp/B08K4SCVKQ) @@ -26,14 +26,6 @@ The number of flashes corresponds to the number of digits in the number of sats + Block connectors + A case. [This repo includes files for a 3D printed case](enclosure) -## Usage instructions -1. Hold button and power on to launch the lamp into access point mode. a solid lamp light inidicates the device is in AP mode. -1. Using a smart phone or computer, connect to the ZapLamp's Wifi AP named "ZapLampAP" with the password "ZipZapZop" -1. When the AP portal opens, select "Configure WiFi" -1. Select your WiFi router and enter it's password into the password field. -1. Optional: Enter the _hex_ value of your npub to watch for Zaps. Use [this tool](https://slowli.github.io/bech32-buffer/) to convert bech32 npub to hex. If you leave this field blank, the lamp will react to all zaps on the relay. -1. Enter a prefered relay if desired and press save - ## Build Instructions + Identify the positive and negative leads of the lamp. Tie a knot in the +ve lead for future identification @@ -44,3 +36,21 @@ The number of flashes corresponds to the number of digits in the number of sats + Connect the push button button to the ESP32 on GPIO4 and GND + Install the lamp, ESP32, button and lead in the printed enclosure + Power on the device and configure using the WiFi access point portal. + +## Firmware Upload Instructions + ++ Use the web installer at https://lamp.600.wtf/ to flash and configure the device ++ Alternatively, use the Arduino IDE to flash the firmware. + - Install the ESP32 board in the Arduino IDE by adding the following URL to the board manager: https://dl.espressif.com/dl/package_esp32_index.json + - Install the following libraries using the Arduino IDE library manager: + - uBitcoin + - WebSockets + - ArduinoJson + - base64 + - WiFiManager + - Nostr + - Open the nostrZapLamp.ino file in the Arduino IDE + - Select the ESP32 Dev Module board and the correct port + - Compile and upload the firmware + - Use the web installer at https://lamp.600.wtf/ to configure the device + \ No newline at end of file