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
115 changes: 110 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,113 @@
# DEPRECATED: LNURLDevice - <small>[LNbits](https://github.com/lnbits/lnbits) extension</small>
## is replaced by [LNPoS](https://github.com/lnbits/lnpos_extension), [FOSSA](https://github.com/lnbits/fossa_extension), [Bitcoin Switch](https://github.com/lnbits/bitcoinswitch_extension)
<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>

<small>For more about LNBits extension check [this tutorial](https://github.com/lnbits/lnbits/wiki/LNbits-Extensions)</small>
[![OpenSats Supported](https://img.shields.io/badge/OpenSats-Supported-orange?logo=bitcoin&logoColor=white)](https://opensats.org)
[![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)
[![DIY MakerBits](https://img.shields.io/badge/DIY-MakerBits-f5ab48?logo=arduino&logoColor=white)](https://t.me/makerbits)
`Author: Ben Arc` `Author: DNI`

For offline LNURL devices
# LNURLDevice (Legacy Extension)
<small>is replaced by [LNPoS](https://github.com/lnbits/lnpos_extension), [FOSSA](https://github.com/lnbits/fossa_extension), [Bitcoin Switch](https://github.com/lnbits/bitcoinswitch_extension)

`Author: Ben Arc` `Author: DNI`
**LNURLDevice** is an older LNbits extension that originally bundled several hardware-related features into a single package — including LNURL-based point-of-sale devices, switch/relay controls, and various automation functions.

For a long period, the extension was enhanced and became **hard unmaintainable**. Thats why we seperated each functionality.
Due to strong user demand and many existing setups relying on it, LNURLDevice has been made **compatible again** within LNBits >v1.3, but it will **not** receive active development or new features.

This extension remains available **solely for legacy compatibility**.

## Extension Status

* **Compatibility:** Maintained
* **Active development:** No
* **Bugfixes:** Only if strictly necessary
* **New features:** None planned
* **Recommended for new projects:** No

LNURLDevice is kept online to avoid breaking existing installations but is no longer part of the future LNbits roadmap.

## Background: Split in LNBits v1.0

Starting from **LNBits v1.0**, LNURLDevice was split into three dedicated extensions for better **maintainability**, clearer scopes, and improved long-term development.

### New Extensions

* **LNPoS** – Modern successor for the LNPoS device
→ [https://github.com/lnbits/lnpos_extension](https://github.com/lnbits/lnpos_extension)

* **BitcoinSwitch** – Switch/relay and automation controls
→ [https://github.com/lnbits/bitcoinswitch_extension](https://github.com/lnbits/bitcoinswitch_extension)

* **FOSSA** – Advanced Bitcoin ATM
→ [https://github.com/lnbits/fossa_extension](https://github.com/lnbits/fossa_extension)

All new setups should use these extensions instead of LNURLDevice.

## Using LNURLDevice (Legacy)

LNURLDevice still works and provides the legacy functionality required by older devices, including:

* early LNPoS hardware
* old BitcoinSwitch flashes
* historic DIY projects
* environments that cannot yet migrate

For new deployments or modern hardware, LNURLDevice is **not recommended**.

## Migration to LNPoS / BitcoinSwitch / FOSSA

> [!IMPORTANT]
> If you want to upgrade an existing LNURLDevice setup, a **manual migration** is required.
#### 1) Install the new extensions

Choose the appropriate one(s): LNPoS, BitcoinSwitch, FOSSA.

#### 2) Create new devices within the corresponding extension

Each device must be recreated inside its proper replacement extension.

#### 3) Re-flash the hardware

Flash the firmware corresponding to the new extension you are moving to.

#### 4) Reconfigure the device

Set up WiFi, wallet, API endpoints, and device-specific settings again.

Once completed, your hardware runs fully under the new extension.

> [!IMPORTANT]
> LNPoS & BitcoinSwitch working with LNURLDevice while FOSSA is not compatible!
# Repositories & Hardware Installers

| Project | Repository Link | Hardware Installer |
|--------------------------|-----------------------------------------------------------------------|-----------------------------------|
| **LNPoS (new)** | https://extensions.lnbits.com/lnpos | https://lnpos.lnbits.com |
| **BitcoinSwitch (new)** | https://github.com/lnbits/bitcoinswitch_extension | https://bitcoinswitch.lnbits.com |
| **FOSSA (new)** | https://github.com/lnbits/fossa_extension | https://fossa.lnbits.com |
| **LNURLDevice (legacy)** | https://github.com/lnbits/lnurldevice | *tba* |

> **Note:**
> LNURLDevice is not actively supported. Some of the hardware installers above *may* still work for flashing,
> but this must be tested individually.
# Note

LNURLDevice will remain available for compatibility but will **not** receive further updates.
For stable and future-proof setups, please use the three new extensions introduced with LNBits v1.0.

---

## Powered by LNbits

LNbits empowers developers and merchants with modular, open-source tools for building Bitcoin-based systems — fast, free, and extendable.

[![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)
[![Read LNbits News](https://img.shields.io/badge/Read-LNbits%20News-F97316?logo=rss&logoColor=white&labelColor=C2410C)](https://news.lnbits.com/)
[![Explore LNbits Extensions](https://img.shields.io/badge/Explore-LNbits%20Extensions-10B981?logo=puzzle-piece&logoColor=white&labelColor=065F46)](https://extensions.lnbits.com/)
[![DIY MakerBits](https://img.shields.io/badge/DIY-MakerBits-f5ab48?logo=arduino&logoColor=white)](https://t.me/makerbits)
10 changes: 9 additions & 1 deletion config.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
{
"id": "lnurldevice",
"version": "0.6.5",
"name": "LNURLDevice",
"repo": "https://github.com/lnbits/lnurldevice",
"short_description": "Hardware focused LNURL helper",
"description": "",
"tile": "/lnurldevice/static/image/lnurldevice.png",
"min_lnbits_version": "0.12.6",
"contributors": [
Expand Down Expand Up @@ -38,5 +42,9 @@
],
"description_md": "https://raw.githubusercontent.com/lnbits/lnurldevice/main/description.md",
"terms_and_conditions_md": "https://raw.githubusercontent.com/lnbits/lnurldevice/main/toc.md",
"license": "MIT"
"license": "MIT",
"paid_features": "",
"tags": ["Hardware", "Deprecated"],
"donate": "",
"hidden": false
}
17 changes: 11 additions & 6 deletions description.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
For LNURL based hardware (although you could use for software), people build things like bitcoin switches, Points of Sale, and ATMs.
Deprecated extension. Use BitcoinSwitch, LNPoS or FOSSA instead.

- LNPoS: https://lnbits.github.io/lnpos
- bitcoinSwitch: https://github.com/lnbits/bitcoinSwitch
- FOSSA: https://github.com/lnbits/fossa
- BATM: https://github.com/lnbits/fossa
- OfflineSwitch: https://github.com/lnbits/fossa
Create LNURL-powered hardware devices like PoS terminals, switches, and ATMs.

Its functions include:

- Configuring LNPoS terminals for merchant payments
- Setting up Bitcoin switches for IoT activation
- Creating FOSSA and BATM hardware integrations
- Supporting offline switch configurations

This extension has been superseded by dedicated extensions that offer improved functionality and better hardware support.
9 changes: 1 addition & 8 deletions toc.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,22 @@
# 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].
If you have any questions about these Terms, please contact the developer at [developer's contact information].
Loading