Skip to content
Merged
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
6 changes: 6 additions & 0 deletions .github/workflows/ftw-drivers-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,12 @@ jobs:
set -euo pipefail
artifacts=("${FTW_DRIVER_CANDIDATE_DIR}"/driver-*.lua)
test -e "${artifacts[0]}"
# Keep notices immutable alongside artifacts from this source commit.
# Earlier files in the rolling channel retain their earlier licenses.
for notice in LICENSE NOTICE LICENSING.md THIRD_PARTY_NOTICES.md; do
cp "${notice}" "${FTW_DRIVER_CANDIDATE_DIR}/${notice}-${GITHUB_SHA}.txt"
artifacts+=("${FTW_DRIVER_CANDIDATE_DIR}/${notice}-${GITHUB_SHA}.txt")
done
existing="$(gh release view "${TAG}" --repo "${GITHUB_REPOSITORY}" --json assets --jq '.assets[].name')"
for artifact in "${artifacts[@]}"; do
name="$(basename "${artifact}")"
Expand Down
9 changes: 6 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,18 @@ Sourceful reviews and maintains changes under the existing license.

## Legal sign-off

Contributions use Apache-2.0 and the Developer Certificate of Origin 1.1. Sign
every commit with your real name and email:
Contributions to this version use GNU AGPL v3 only with the Energyplan
combination permission in LICENSE, including that permission. Preserve
third-party licenses and notices. Use the Developer Certificate of Origin
1.1 and sign every commit with your real name and email:

```bash
git commit -s -m "feat(driver): add example meter"
```

The sign-off confirms that you wrote the contribution or have the right to
submit it under this license.
submit it under these terms. A sign-off does not assign copyright or grant
commercial relicensing rights. See [LICENSING.md](LICENSING.md).

## Start a driver

Expand Down
469 changes: 268 additions & 201 deletions LICENSE

Large diffs are not rendered by default.

51 changes: 51 additions & 0 deletions LICENSING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Sourceful Device Drivers licensing

This version uses GNU AGPL v3 only, with the narrow Energyplan combination
permission in [LICENSE](LICENSE). [NOTICE](NOTICE) preserves prior Apache
rights and attribution. Third-party files retain their own licenses.

## Use and redistribution

You may inspect, run, modify and sell the AGPL-covered software. When you
convey a covered work, provide its Corresponding Source under the AGPL.
When you modify it and let users interact with it remotely over a network,
offer those users that version's Corresponding Source at no charge as section
13 requires. A separate program does not become AGPL merely by sharing a
distribution or communicating over an API; the actual combination matters.
These paragraphs explain the license; LICENSE contains the binding terms.

Sourceful Labs AB may offer separate commercial terms for rights it controls.
Such a contract must identify the software and rights covered. It does not
replace third-party licenses or change earlier grants. A DCO sign-off is not
a copyright assignment or a general right to offer proprietary licenses.

## Energyplan

Energyplan's proprietary binaries have a separate license. The permission in
LICENSE allows the specified combination without requiring Energyplan source;
it does not license the binary or extend that exception to other closed code.
The binary license bundled with the exact worker governs its use. New workers
under the Energyplan Home Use Binary License allow private household use with
FTW and free, noncommercial redistribution for that use. Commercial use,
bundling, resale and services require a separate Sourceful license. Earlier
workers keep their earlier grants. None of these restrictions apply to FTW's
AGPL-covered code when used without those restricted binaries.

## Source for a distributed version

The source repository is https://github.com/srcfl/device-drivers.
Use the running build's commit or release tag, not the moving default branch,
to obtain matching source. Download an archive from that revision's Code menu,
or clone the repository and check out the revision. Include build and install
scripts, dependency lockfiles, license notices and any required installation
information. FTW Core's driver pin identifies its separately supplied driver
source and that snapshot's license; the bundled driver scripts are also source
code. An older pinned snapshot retains its earlier license.

Distributors must publish all their changes and any additional source needed
to meet the license, keep the source available for the required period, and
update source links to their own matching source. An upstream link alone is
not a source offer for a modified fork or an uncommitted build. For consumer
devices, meet AGPL section 6's Installation Information requirements where
they apply. Publishing source does not require publishing user data, secrets
or Energyplan source covered by the combination permission.
224 changes: 224 additions & 0 deletions NOTICE
Original file line number Diff line number Diff line change
@@ -0,0 +1,224 @@
Sourceful Device Drivers
Copyright 2026 Sourceful Labs AB and contributors.

License transition: 2026-09-12
------------------------------
This version changes the license of the project as a whole to GNU AGPL v3
only with the Energyplan combination permission in LICENSE. It does not
withdraw any rights already granted for earlier copies or their code.
The Apache-licensed default-branch snapshot used for this transition was:
https://github.com/srcfl/device-drivers/tree/91f49bd869300e4985979823971787d9cc6eb883

That snapshot was offered under Apache-2.0. Its copyright holders keep their
copyrights and the permissions they previously granted remain available.
The following prior notices and Apache license apply to that material.
They do not offer later changes under Apache-2.0. Git history records authors,
changes and dates. Separately licensed third-party files keep their notices.



Prior Apache license, retained verbatim
--------------------------------------
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

End of prior Apache license.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,5 +149,6 @@ target identities from [support-status.json](support-status.json).

## License

Sourceful-authored code is licensed under Apache-2.0. Vendored Lua 5.5 source
This version uses AGPL-3.0-only with the Energyplan combination permission
in [LICENSE](LICENSE). See [LICENSING.md](LICENSING.md) and [NOTICE](NOTICE). Vendored Lua 5.5 source
keeps its own MIT notice; see [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).
4 changes: 2 additions & 2 deletions tools/generate_site.py
Original file line number Diff line number Diff line change
Expand Up @@ -964,7 +964,7 @@ def render_html(catalog: dict) -> str:
<main id="content">
<section class="hero" id="top">
<div class="wrap">
<p class="kicker"><span class="dot" aria-hidden="true"></span>Apache-2.0 &middot; One driver per device &middot; Built from the repository</p>
<p class="kicker"><span class="dot" aria-hidden="true"></span>AGPL-3.0-only &middot; One driver per device &middot; Built from the repository</p>
<h1>Every driver, and what <em>stands behind it.</em></h1>
<p class="lede">These are the Lua drivers Sourceful publishes for FTW and Blixt L1 — solar inverters,
batteries, meters, heat pumps and EV charging. Each entry is generated from the manifest and the driver
Expand Down Expand Up @@ -1055,7 +1055,7 @@ def render_html(catalog: dict) -> str:
</div>
</div>
<div class="wrap footer-bottom">
<span>&copy; Sourceful Labs AB and contributors &middot; Apache-2.0</span>
<span>&copy; Sourceful Labs AB and contributors &middot; AGPL-3.0-only</span>
<span>Generated from {commit_line or "the repository"} &middot;
<a href="./drivers.json">drivers.json</a></span>
</div>
Expand Down