Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
<a href="https://lnbits.com" target="_blank" rel="noopener noreferrer">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://i.imgur.com/QE6SIrs.png">
<img src="https://i.imgur.com/fyKPgVT.png" alt="LNbits" style="width:280px">
</picture>
</a>

[![License: MIT](https://img.shields.io/badge/License-MIT-success?logo=open-source-initiative&logoColor=white)](./LICENSE)
[![Built for LNbits](https://img.shields.io/badge/Built%20for-LNbits-4D4DFF?logo=lightning&logoColor=white)](https://github.com/lnbits/lnbits)

# Bitcoin Switch - [LNbits](https://lnbits.com) extension

Turn things on with bitcoin. Control relays, motors, or any electronic device by receiving lightning payments. Perfect for vending machines, access control, or any pay-to-use scenario.

Flash your own device using the web installer at [bitcoinswitch.lnbits.com](https://bitcoinswitch.lnbits.com)

<img width="600" src="https://user-images.githubusercontent.com/33088785/166832680-600ed270-cbc9-4749-82f1-c1853b242329.png"><img width="600" src="https://user-images.githubusercontent.com/33088785/166829474-a28ca2b7-dd3e-46d4-89d3-8a10bf1d3fad.png">

# Clicky, the Bitcoin Switch
Expand Down Expand Up @@ -97,3 +113,34 @@ uploading
```console
arduino-cli upload --fqbn esp32:esp32:esp32 --input-dir build -p /dev/ttyUSB1
```

## How it works

The extension creates LNURL endpoints that trigger GPIO pins on ESP32 hardware when payments are received. You define how long the switch stays on and what amount triggers it.

## Features

- Control relays and GPIO pins via lightning payments
- Configurable activation duration
- Multiple switch configurations per device
- Works with any ESP32-based hardware

## Usage

1. Enable the extension in LNbits
2. Create a switch and configure the amount and duration
3. Flash your ESP32 using the web installer
4. Connect your relay or device to the configured GPIO pin
5. Share the payment link or QR code

## Resources

- [Video tutorials](https://www.youtube.com/@makerbits7700)
- [Support group on Telegram](https://t.me/makerbits)

## Powered by LNbits

[LNbits](https://lnbits.com) is a free and open-source lightning accounts system.

[![Visit LNbits Shop](https://img.shields.io/badge/Visit-LNbits%20Shop-7C3AED?logo=shopping-cart&logoColor=white&labelColor=5B21B6)](https://shop.lnbits.com/)
[![Try myLNbits SaaS](https://img.shields.io/badge/Try-myLNbits%20SaaS-2563EB?logo=lightning&logoColor=white&labelColor=1E40AF)](https://my.lnbits.com/login)
47 changes: 47 additions & 0 deletions config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
{
"id": "bitcoinswitch",
"version": "1.2.0",
"name": "Bitcoin Switch",
"repo": "https://github.com/lnbits/bitcoinswitch-extension",
"short_description": "Turn things on with bitcoin lightning",
"description": "",
"tile": "/bitcoinswitch/static/image/icon.png",
"min_lnbits_version": "1.4.0",
"contributors": [
{
"name": "Ben Arc",
"uri": "mailto:ben@lnbits.com",
"role": "Developer"
},
{
"name": "BlackCoffee",
"uri": "https://github.com/blackcoffee",
"role": "Developer"
},
{
"name": "Vlad Stan",
"uri": "https://github.com/motorina1",
"role": "Developer"
},
{
"name": "dni",
"uri": "https://github.com/dni",
"role": "Developer"
}
],
"images": [
{
"uri": "https://raw.githubusercontent.com/lnbits/bitcoinswitch-extension/main/static/image/1.png"
},
{
"uri": "https://raw.githubusercontent.com/lnbits/bitcoinswitch-extension/main/static/image/2.png"
}
],
"description_md": "https://raw.githubusercontent.com/lnbits/bitcoinswitch-extension/main/description.md",
"terms_and_conditions_md": "https://raw.githubusercontent.com/lnbits/bitcoinswitch-extension/main/toc.md",
"license": "MIT",
"paid_features": "",
"tags": ["Hardware", "IoT"],
"donate": "",
"hidden": false
}
10 changes: 10 additions & 0 deletions description.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Turn things on with Bitcoin by connecting physical devices that activate upon Lightning payment.

Its functions include:

- Triggering physical devices like lights, motors, or appliances
- Configuring activation duration and payment amounts
- Supporting multiple switch configurations
- Integrating with DIY hardware projects

A fun and practical solution for makers, educators, and businesses who want to create interactive Bitcoin-powered experiences or automate physical processes.
Binary file added static/image/1.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 static/image/2.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 static/image/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
29 changes: 29 additions & 0 deletions toc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Terms and Conditions for LNbits Extension

## 1. Acceptance of Terms

By installing and using the LNbits extension ("Extension"), you agree to be bound by these terms and conditions ("Terms"). If you do not agree to these Terms, do not use the Extension.

## 2. License

The Extension is free and open-source software, released under [specify the FOSS license here, e.g., GPL-3.0, MIT, etc.]. You are permitted to use, copy, modify, and distribute the Extension under the terms of that license.

## 3. No Warranty

The Extension is provided "as is" and with all faults, and the developer expressly disclaims all warranties of any kind, whether express, implied, statutory, or otherwise, including but not limited to warranties of merchantability, fitness for a particular purpose, non-infringement, and any warranties arising out of course of dealing or usage of trade. No advice or information, whether oral or written, obtained from the developer or elsewhere will create any warranty not expressly stated in this Terms.

## 4. Limitation of Liability

In no event will the developer be liable to you or any third party for any direct, indirect, incidental, special, consequential, or punitive damages, including lost profit, lost revenue, loss of data, or other damages arising out of or in connection with your use of the Extension, even if the developer has been advised of the possibility of such damages. The foregoing limitation of liability shall apply to the fullest extent permitted by law in the applicable jurisdiction.

## 5. Modification of Terms

The developer reserves the right to modify these Terms at any time. You are advised to review these Terms periodically for any changes. Changes to these Terms are effective when they are posted on the appropriate location within or associated with the Extension.

## 6. General Provisions

If any provision of these Terms is held to be invalid or unenforceable, that provision will be enforced to the maximum extent permissible, and the other provisions of these Terms will remain in full force and effect. These Terms constitute the entire agreement between you and the developer regarding the use of the Extension.

## 7. Contact Information

If you have any questions about these Terms, please contact the developer at [developer's contact information].