Metadata-Version: 2.4
Name: arthexis
Version: 0.2.5
Summary: Energy & Power Infrastructure
Author-email: "Rafael J. Guillén-Osorio" <tecnologia@gelectriic.com>
License-Expression: LicenseRef-ARG-1.0
Project-URL: Repository, https://github.com/arthexis/arthexis
Project-URL: Homepage, https://arthexis.com
Classifier: Programming Language :: Python :: 3
Classifier: Framework :: Django
Requires-Python: <3.14,>=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: anyio==4.13.0
Requires-Dist: asgiref==3.11.0
Requires-Dist: autobahn==24.4.2
Requires-Dist: bleach==6.3.0
Requires-Dist: boto3==1.42.91
Requires-Dist: botocore==1.42.96
Requires-Dist: celery==5.5.3
Requires-Dist: cffi==2.0.0
Requires-Dist: channels-redis==4.3.0
Requires-Dist: channels==4.3.2
Requires-Dist: click-didyoumean==0.3.1
Requires-Dist: click-plugins==1.1.1.2
Requires-Dist: click-repl==0.3.0
Requires-Dist: click==8.3.2
Requires-Dist: colorama==0.4.6
Requires-Dist: cron-descriptor==2.0.8
Requires-Dist: cryptography<47.1.0,>=46.0.5
Requires-Dist: daphne==4.2.1
Requires-Dist: defusedxml==0.7.1
Requires-Dist: diff-match-patch==20241021
Requires-Dist: django-celery-beat==2.8.1
Requires-Dist: django-encrypted-model-fields==0.6.5
Requires-Dist: django-import-export==4.4.0
Requires-Dist: django-mermaid==0.1.1
Requires-Dist: django-object-actions==5.0.0
Requires-Dist: django-otp==1.7.0
Requires-Dist: django-parler==2.3
Requires-Dist: django-timezone-field==7.2.1
Requires-Dist: Django==5.2.12
Requires-Dist: dnspython==2.7.0
Requires-Dist: docutils==0.22.4
Requires-Dist: filelock==3.29.0
Requires-Dist: httpx==0.28.1
Requires-Dist: kombu==5.5.4
Requires-Dist: Markdown==3.10.2
Requires-Dist: mdx_truly_sane_lists==1.3
Requires-Dist: packaging==26.2
Requires-Dist: pillow==12.2.0
Requires-Dist: plyer==2.1.0; sys_platform == "win32"
Requires-Dist: prompt_toolkit==3.0.52
Requires-Dist: psutil==7.2.2
Requires-Dist: psycopg-binary==3.3.3
Requires-Dist: psycopg==3.3.3
Requires-Dist: pycparser==3.0
Requires-Dist: pyOpenSSL==26.0.0
Requires-Dist: PySocks==1.7.1
Requires-Dist: python-crontab==3.3.0
Requires-Dist: python-dateutil==2.9.0.post0
Requires-Dist: python-dotenv==1.2.2
Requires-Dist: PyYAML==6.0.3
Requires-Dist: redis==7.4.0
Requires-Dist: reportlab==4.4.10
Requires-Dist: requests==2.33.1
Requires-Dist: setuptools==82.0.1
Requires-Dist: sqlparse==0.5.5
Requires-Dist: tablib==3.9.0
Requires-Dist: tinycss2==1.5.1
Requires-Dist: toml==0.10.2
Requires-Dist: tomli>=1.1.0; python_version < "3.11"
Requires-Dist: Twisted==25.5.0
Requires-Dist: txaio==25.9.2
Requires-Dist: typing_extensions==4.15.0
Requires-Dist: urllib3~=2.6.3
Requires-Dist: weasyprint==68.1
Requires-Dist: webauthn==2.7.1
Requires-Dist: websocket-client==1.8.0
Requires-Dist: websockets<17,>=15
Requires-Dist: whitenoise==6.12.0
Provides-Extra: ci
Requires-Dist: black==26.3.1; extra == "ci"
Requires-Dist: django-stubs-ext==6.0.3; extra == "ci"
Requires-Dist: django-stubs==6.0.3; extra == "ci"
Requires-Dist: import-linter==2.11; extra == "ci"
Requires-Dist: ruff==0.15.11; extra == "ci"
Requires-Dist: twine==6.1.0; extra == "ci"
Requires-Dist: types-requests==2.33.0.20260408; extra == "ci"
Provides-Extra: dev
Requires-Dist: django-debug-toolbar==6.3.0; extra == "dev"
Provides-Extra: docs
Requires-Dist: mkdocs==1.6.1; extra == "docs"
Provides-Extra: ftp
Requires-Dist: pyftpdlib==2.2.0; extra == "ftp"
Provides-Extra: hardware
Requires-Dist: gpiozero==2.0.1; (sys_platform == "linux" and (platform_machine == "armv7l" or platform_machine == "aarch64")) and extra == "hardware"
Requires-Dist: mfrc522==0.0.7; (sys_platform == "linux" and (platform_machine == "armv7l" or platform_machine == "aarch64") and python_version < "3.12") and extra == "hardware"
Requires-Dist: smbus2==0.6.1; (sys_platform == "linux" and (platform_machine == "armv7l" or platform_machine == "aarch64")) and extra == "hardware"
Provides-Extra: nodes
Requires-Dist: graphviz==0.21; extra == "nodes"
Requires-Dist: qrcode==8.2; extra == "nodes"
Provides-Extra: preview
Requires-Dist: playwright==1.58.0; extra == "preview"
Requires-Dist: selenium==4.43.0; extra == "preview"
Provides-Extra: qa
Requires-Dist: pytest-asyncio==1.3.0; extra == "qa"
Requires-Dist: pytest-django==4.12.0; extra == "qa"
Requires-Dist: pytest-timeout==2.4.0; extra == "qa"
Requires-Dist: pytest-xdist==3.8.0; extra == "qa"
Requires-Dist: pytest==9.0.3; extra == "qa"
Provides-Extra: video
Requires-Dist: aiortc==1.14.0; extra == "video"
Requires-Dist: opencv-python==4.13.0.92; extra == "video"
Requires-Dist: trio-websocket==0.12.2; extra == "video"
Requires-Dist: trio==0.31.0; extra == "video"
Dynamic: license-file

# Constellation

[![OCPP 1.6 Coverage](https://raw.githubusercontent.com/arthexis/arthexis/main/media/ocpp_coverage.svg)](https://github.com/arthexis/arthexis/blob/main/docs/development/ocpp-user-manual.md) [![OCPP 2.0.1 Coverage](https://raw.githubusercontent.com/arthexis/arthexis/main/media/ocpp201_coverage.svg)](https://github.com/arthexis/arthexis/blob/main/docs/development/ocpp-user-manual.md) [![OCPP 2.1 Coverage](https://raw.githubusercontent.com/arthexis/arthexis/main/media/ocpp21_coverage.svg)](https://github.com/arthexis/arthexis/blob/main/docs/development/ocpp-user-manual.md)
[![Install CI](https://img.shields.io/github/actions/workflow/status/arthexis/arthexis/install-hourly.yml?branch=main&label=Install%20CI&cacheSeconds=300)](https://github.com/arthexis/arthexis/actions/workflows/install-hourly.yml) [![PyPI](https://img.shields.io/pypi/v/arthexis?label=PyPI)](https://pypi.org/project/arthexis/) [![License: Arthexis 1.0](https://img.shields.io/badge/License-Arthexis%201.0-blue.svg)](https://github.com/arthexis/arthexis/blob/main/LICENSE)


## Purpose

Arthexis Constellation is a Django-based software suite that centralizes tools for managing electric vehicle charging infrastructure and orchestrating energy-related products and services.

Visit our [Changelog Report](https://arthexis.com/changelog/) to browse release history and operational updates.

For release confidence and version lifecycle expectations, see the [Versioning and Maturity Policy](https://github.com/arthexis/arthexis/blob/main/docs/development/versioning-maturity-policy.md).

## Suite Features

- Compatible with the [Open Charge Point Protocol (OCPP) 1.6](https://www.openchargealliance.org/protocols/ocpp-16/) by default, while allowing Charging Stations to upgrade to newer protocols if they support them.

  **Charge point → CSMS**

  | Action | 1.6 | 2.0.1 | 2.1 | What we do |
  | --- | --- | --- | --- | --- |
  | `Authorize` | ✅ | ✅ | ✅ | Validate RFID or token authorization requests before a session starts. |
  | `BootNotification` | ✅ | ✅ | ✅ | Register the charge point and update identity, firmware, and status details. |
  | `DataTransfer` | ✅ | ✅ | ✅ | Accept vendor-specific payloads and record the results. |
  | `DiagnosticsStatusNotification` | ✅ | — | — | Track the progress of diagnostic uploads kicked off from the back office. |
  | `FirmwareStatusNotification` | ✅ | ✅ | ✅ | Track firmware update lifecycle events from charge points. |
  | `Heartbeat` | ✅ | ✅ | ✅ | Keep the websocket session alive and update last-seen timestamps. |
  | `LogStatusNotification` | — | ✅ | ✅ | Report log upload progress from the charge point for diagnostics oversight. |
  | `MeterValues` | ✅ | ✅ | ✅ | Persist periodic energy and power readings while a transaction is active. |
  | `SecurityEventNotification` | — | ✅ | ✅ | Record charge point security events for audit trails. |
  | `StartTransaction` | ✅ | — | — | Create charging sessions with initial meter values and identification data. |
  | `StatusNotification` | ✅ | ✅ | ✅ | Reflect connector availability and fault states in real time. |
  | `StopTransaction` | ✅ | — | — | Close charging sessions, capturing closing meter values and stop reasons. |

  **CSMS → Charge point**

  | Action | 1.6 | 2.0.1 | 2.1 | What we do |
  | --- | --- | --- | --- | --- |
  | `CancelReservation` | ✅ | ✅ | ✅ | Withdraw pending reservations and release connectors directly from the control center. |
  | `ChangeAvailability` | ✅ | ✅ | ✅ | Switch connectors or the whole station between operative and inoperative states. |
  | `ChangeConfiguration` | ✅ | — | — | Update supported charger settings and persist applied values in the control center. |
  | `ClearCache` | ✅ | ✅ | ✅ | Flush local authorization caches to force fresh lookups from the CSMS. |
  | `DataTransfer` | ✅ | ✅ | ✅ | Send vendor-specific commands and log the charge point response. |
  | `GetConfiguration` | ✅ | — | — | Poll the device for the current values of tracked configuration keys. |
  | `GetDiagnostics` | ✅ | — | — | Request a diagnostics archive upload to a signed URL for troubleshooting. |
  | `GetLocalListVersion` | ✅ | ✅ | ✅ | Retrieve the current RFID whitelist version and synchronize entries reported by the charge point. |
  | `RemoteStartTransaction` | ✅ | — | — | Initiate a charging session remotely for an identified customer or token. |
  | `RemoteStopTransaction` | ✅ | — | — | Terminate active charging sessions from the control center. |
  | `ReserveNow` | ✅ | ✅ | ✅ | Reserve connectors for upcoming sessions with automatic connector selection and confirmation tracking. |
  | `Reset` | ✅ | ✅ | ✅ | Request a soft or hard reboot to recover from faults. |
  | `SendLocalList` | ✅ | ✅ | ✅ | Publish released and approved RFIDs as the charge point's local authorization list. |
  | `TriggerMessage` | ✅ | ✅ | ✅ | Ask the device to send an immediate update (for example status or diagnostics). |
  | `UnlockConnector` | ✅ | ✅ | ✅ | Release stuck connectors without on-site intervention. |
  | `UpdateFirmware` | ✅ | ✅ | ✅ | Deliver firmware packages to chargers with secure download tokens and track installation responses. |

## Role Architecture

Arthexis Constellation ships in four node roles tailored to different deployment scenarios.

> [!NOTE]
> **Terminal** is the default role and keeps environment-changing capabilities disabled by default.
> Other roles may enable host-level features (such as networking changes or background services), so choose them only when those capabilities are needed.

<table border="1" cellpadding="8" cellspacing="0">
  <thead>
    <tr>
      <th align="left">Role</th>
      <th align="left">Description &amp; Common Features</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td valign="top"><strong>Terminal</strong></td>
      <td valign="top"><strong>Single-User Research &amp; Development</strong><br />Features: GUI Toast</td>
    </tr>
    <tr>
      <td valign="top"><strong>Control</strong></td>
      <td valign="top"><strong>Single-Device Testing &amp; Special Task Appliances</strong><br />Features: AP Public Wi-Fi, Celery Queue, GUI Toast, LCD Screen, NGINX Server, RFID Scanner</td>
    </tr>
    <tr>
      <td valign="top"><strong>Satellite</strong></td>
      <td valign="top"><strong>Multi-Device Edge, Network &amp; Data Acquisition</strong><br />Features: AP Router, Celery Queue, NGINX Server, RFID Scanner</td>
    </tr>
    <tr>
      <td valign="top"><strong>Watchtower</strong></td>
      <td valign="top"><strong>Multi-User Cloud &amp; Orchestration</strong><br />Features: Celery Queue, NGINX Server</td>
    </tr>
  </tbody>
</table>

## Quick Guide

### 1. Clone
- **Linux**: open a terminal and run `git clone https://github.com/arthexis/arthexis.git`.
- **Windows**: open PowerShell or Git Bash and run the same command.

For preloaded environments without Git remotes configured, see the remotes note in the [Install & Lifecycle Scripts Manual](https://github.com/arthexis/arthexis/blob/main/docs/development/install-lifecycle-scripts-manual.md#git-remotes-for-preloaded-environments).

### 2. Start and stop
Terminal nodes can start directly with the scripts below without installing; Control, Satellite, and Watchtower roles require installation first. Both approaches listen on `localhost:8888` by default.

For local bootstrapping, run `./install.sh --terminal`, start the server with `./start.sh`, and run a quick smoke test with `pytest -k smoke`. For full runtime options and advanced usage, refer to the [Install & Lifecycle Scripts Manual](https://github.com/arthexis/arthexis/blob/main/docs/development/install-lifecycle-scripts-manual.md#21-linux-startsh).

- **VS Code**
   - Open the folder and go to the **Run and Debug** panel (`Ctrl+Shift+D`).
   - Select the **Run Server** (or **Debug Server**) configuration.
   - Press the green start button. Stop the server with the red square button (`Shift+F5`).

- **Shell**
   - Linux: run [`./start.sh`](https://github.com/arthexis/arthexis/blob/main/start.sh) and stop with [`./stop.sh`](https://github.com/arthexis/arthexis/blob/main/stop.sh).
   - Windows: run [`start.bat`](https://github.com/arthexis/arthexis/blob/main/start.bat) and stop with [`stop.bat`](https://github.com/arthexis/arthexis/blob/main/stop.bat).

### 3. Install and upgrade
- **Linux:** run `./install.sh --terminal` (or another role preset) and use [`./upgrade.sh`](https://github.com/arthexis/arthexis/blob/main/upgrade.sh) for updates.
- **Windows:** run [`install.bat`](https://github.com/arthexis/arthexis/blob/main/install.bat) and [`upgrade.bat`](https://github.com/arthexis/arthexis/blob/main/upgrade.bat).

Detailed install flags, service-management choices, and upgrade-channel behavior are documented in:

- [Install & Lifecycle Scripts Manual](https://github.com/arthexis/arthexis/blob/main/docs/development/install-lifecycle-scripts-manual.md)
- [Auto-Upgrade Flow](https://github.com/arthexis/arthexis/blob/main/docs/auto-upgrade.md)

### 4. Administration
- Access the Django admin at `localhost:8888/admin/` to review and manage live data. Use `--port` with the start scripts or installer when you need to expose a different port.
- Browse the admindocs at `localhost:8888/admindocs/` for API documentation that is generated from your models.
- Follow the [Install & Administration Guide](https://github.com/arthexis/arthexis/blob/main/apps/docs/cookbooks/install-start-stop-upgrade-uninstall.md) for deployment, lifecycle tasks, and operational runbooks.
- Onboard and service chargers with the [EVCS Connectivity & Maintenance Cookbook](https://github.com/arthexis/arthexis/blob/main/apps/docs/cookbooks/evcs-connectivity-maintenance.md).
- Configure payment gateways with the [Payment Processors Cookbook](https://github.com/arthexis/arthexis/blob/main/apps/docs/cookbooks/payment-processors.md).
- Reference the [Sigils Cookbook](https://github.com/arthexis/arthexis/blob/main/apps/docs/cookbooks/sigils.md) when configuring tokenized settings across environments.
- Understand seed fixtures and per-user files with [Managing Local Node Data](https://github.com/arthexis/arthexis/blob/main/apps/docs/cookbooks/managing-local-node-data.md).
- Manage exports, imports, and audit trails with the [User Data Cookbook](https://github.com/arthexis/arthexis/blob/main/apps/docs/cookbooks/user-data.md).
- Plan node capability adoption and configuration using the [Node Features Cookbook](apps/docs/cookbooks/node-features.md).
- Curate shortcuts for power users through the [Favorites Cookbook](https://github.com/arthexis/arthexis/blob/main/apps/docs/cookbooks/favorites.md).
- Connect Slack workspaces through the [Slack Bot Onboarding Cookbook](https://github.com/arthexis/arthexis/blob/main/apps/docs/cookbooks/slack-bot-onboarding.md).

### 5. Development
- Browse the [Developer Documentation Library](https://arthexis.com/docs/library/) for architecture references, protocol manuals, and contribution workflows.
- Command convention:
  - Default to `.venv/bin/python manage.py ...` for Django and developer tasks.
  - Prefer `./command.sh ...` (or `command.bat ...` on Windows) for operational tasks when an instance is already up.
  - Keep using dedicated scripts (for example `install.sh`, `start.sh`, `upgrade.sh`) when a task has a specific lifecycle entrypoint.

## Support

Arthexis Constellation is actively maintained with documented release notes and operational guidance.

If you decide to use our suite for your energy projects, you may contact us at [tecnologia@gelectriic.com](mailto:tecnologia@gelectriic.com) or visit our [web page](https://www.gelectriic.com/) for professional services and commercial support.

## License and Sponsorship

Arthexis is distributed under the Arthexis Reciprocity General License 1.0. In addition to code, docs, reviews, and maintenance, we also consider sponsoring Arthexis and doing paid or volunteer work for the open-source dependencies we rely on to be a valid and important form of contribution.

If Arthexis helps your team, please review the license terms in [`LICENSE`](https://github.com/arthexis/arthexis/blob/main/LICENSE) and consider sponsoring or directly supporting the maintainers of the libraries, frameworks, and infrastructure projects that make this suite possible. Supporting those dependencies helps keep the whole Arthexis ecosystem healthy.
