paulg/venus
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
9756538f16ae5a1aae7d35a32183404125730e63
venus/_template/README.md
dev 9756538f16 Initial commit: Venus OS boat addons monorepo 
Organizes 11 projects for Cerbo GX/Venus OS into a single repository:
- axiom-nmea: Raymarine LightHouse protocol decoder
- dbus-generator-ramp: Generator current ramp controller
- dbus-lightning: Blitzortung lightning monitor
- dbus-meteoblue-forecast: Meteoblue weather forecast
- dbus-no-foreign-land: noforeignland.com tracking
- dbus-tides: Tide prediction from depth + harmonics
- dbus-vrm-history: VRM cloud history proxy
- dbus-windy-station: Windy.com weather upload
- mfd-custom-app: MFD app deployment package
- venus-html5-app: Custom Victron HTML5 app fork
- watermaker: Watermaker PLC control UI

Adds root README, .gitignore, project template, and per-project
.gitignore files. Sensitive config files excluded via .gitignore
with .example templates provided.

Made-with: Cursor
2026-03-16 17:04:16 +00:00

1.7 KiB
Raw Blame History

dbus-template

Venus OS D-Bus service template. Use this as a starting point for new services.

Getting Started

  1. Copy this directory: cp -r _template/ dbus-your-service-name/
  2. Rename dbus-template.py to match your service (e.g. your_service.py)
  3. Update config.py with your service name, product ID, and settings
  4. Update service/run to point to your renamed main script
  5. Update install.sh: set SERVICE_NAME and MAIN_SCRIPT variables
  6. Update build-package.sh: set PACKAGE_NAME and the file copy list
  7. Replace this README with your own documentation

Files

File Purpose
dbus-template.py Main service with D-Bus registration boilerplate
config.py Configuration constants (service name, product ID, timing)
service/run daemontools entry point
service/log/run multilog configuration
install.sh Venus OS installation (velib symlink, service registration, rc.local)
uninstall.sh Removes service symlink
build-package.sh Creates a deployable .tar.gz package

D-Bus Paths

Update these for your service:

Path Type Description
/ProductName string Service display name
/Connected int Connection status (0/1)
/Settings/Template/Enabled int Enable/disable via settings

Checklist

  • Unique service name in config.py (com.victronenergy.yourservice)
  • Unique product ID in config.py (check existing services to avoid conflicts)
  • All file references updated in service/run, install.sh, build-package.sh
  • Custom D-Bus paths added
  • Settings paths updated
  • README replaced with your own documentation
Reference in New Issue View Git Blame Copy Permalink