Skip to content

direct.md

Latest commit

 

History

History
50 lines (37 loc) · 1.69 KB

direct.md

File metadata and controls

50 lines (37 loc) · 1.69 KB
Raw

Direct Installation

A manual installation on Windows, macOS, or Linux is the most flexible option, suited to development or custom setups. It requires a Python environment.

Prerequisites

  1. Python: Use Python 3.10 or newer (see CONTRIBUTING.md). You can download Python from the official Python website.
  2. Configuration: Create a config.ini file in the root directory of the project and add the appropriate configuration as described in the Configuration reference.

Installation steps

  1. Open a terminal / command prompt

    • Windows: Press Win + R, type cmd, press Enter
    • macOS: Press Cmd + Space, type Terminal, press Enter
    • Linux: Use your preferred terminal emulator

  2. Navigate to the project directory

    cd path/to/astrameter

  3. Install uv (dependency manager).

  4. Install dependencies and run

    uv sync
uv run astrameter

    With dev tools (tests, ruff, mypy): uv sync --extra dev. See CONTRIBUTING.md for the full workflow.

All commands above work across Windows, macOS, and Linux. The only difference is how you open your terminal.

When the script is running, switch your Marstek battery to "Self-Adaptation" mode to enable the powermeter functionality.

Autostart on boot (Linux)

Use systemd to create a service:

  1. Create a unit file (e.g., /etc/systemd/system/astrameter.service)
  2. Set ExecStart to your startup command
  3. Enable and start: sudo systemctl enable astrameter && sudo systemctl start astrameter