Getting started with Sourceful

Getting-started guides for Sourceful Energy's devices. One guide per product, written for the person on site who has to make it work. Every guide comes with a printable one-pager in English and Swedish.

Svenska: README.sv.md

Product	What it does	Guide	One-pager
Zap P1	Reads a meter's RJ12 P1 port and sends meter data to the Sourceful Energy app	zap/	EN · SV
Zap HAN	Reads a meter's RJ45 HAN port (M-Bus), powered by USB-C	zap-han/	EN · SV
Blixt	Industrial gateway that controls batteries, inverters, meters and EV chargers on commercial and industrial sites	blixt/	EN · SV
Blixt X	Sourceful's gateway software on the RAK Hotspot V2 (the former dual miners), set up in the app like a Zap	blixt-x/	EN · SV

App screenshots

mobile/onboarding/ walks through onboarding a Zap and adding an inverter in the app, screen by screen (Swedish).

Device drawings

Every device drawn in the one-pagers is also in assets/devices/ as an SVG, built from the same code:

Zap P1	Zap HAN	Blixt IPC3630	Blixt IPC2210	Blixt X (RAK Hotspot V2)

How we keep the guides good

The guides must be correct, concrete and easy to read. Each guide says at the top what it applies to and when it was last checked against its sources, and lists the sources at the bottom. Where sources disagree, the guide says so under Open questions instead of guessing. The rules are in CONTRIBUTING.md, and CI checks them on every change.

None of the guides has been walked through on real hardware yet. Each product has a CHECKLIST.md for that, and the guides and one-pagers say "not field-tested" until it is done.

Found a step that is wrong? Open an issue or a pull request. A mistake in a guide is a mistake on site.

Repository layout

<product>/README.md                  the guide in English
<product>/README.sv.md               the guide in Swedish
<product>/<product>-one-pager-en.pdf the one-pager in English
<product>/<product>-one-pager-sv.pdf the one-pager in Swedish
<product>/images/                    product images and one-pager previews
onepagers/                           the source of every one-pager and device drawing
assets/devices/                      the device drawings as SVG (built)
assets/fonts/, assets/brand/         fonts and the Sourceful logo
scripts/check_guides.py              the checks CI runs

Build the one-pagers:

pip install weasyprint==70.0
python3 onepagers/build.py --thumbs

More help

• Support articles: support.sourceful.energy
• The old Energy Gateway guide (2024) is kept under the tag egw-2024.