Welcome to CitrineOS

CitrineOS is an open-source project aimed at providing a modular server runtime for managing Electric Vehicle (EV) charging infrastructure. This README will guide you through the process of installing and running CitrineOS.

This is the main part of CitrineOS containing the actual charging station management logic, OCPP message routing and all modules.

All other documentation and the issue tracking can be found in our main repository here: https://github.com/citrineos/citrineos.

Table of Contents

• Overview
• Prerequisites
• Installation
• Starting the Server without Docker
• Attaching Debugger
• Usage
• Testing with EVerest
• Running clean and fresh
• Linting and Prettier
• Information on Docker setup
• Generating OCPP Interfaces
• Contributing
• Licensing
• Support and contact
• Roadmap

Overview

CitrineOS is developed in TypeScript and runs on NodeJS with ws and fastify.

The system features:

• Dynamic OCPP 2.0.1 message schema validation, prior to transmission using AJV
• Generated OpenAPIv3 specification for easy developer access
• Configurable logical modules with decorators
  • @AsHandler to handle incoming OCPP 2.0.1 messages
  • @AsMessageEndpoint to expose functions allowing to send messages to charging stations
  • @AsDataEndpoint to expose CRUD access to entities defined in 01_Data
• Utilities to connect and extend various message broker and cache mechanisms
  • Currently supported brokers are RabbitMQ and Google Cloud PubSub
  • Currently supported caches are In Memory and Redis

For more information on the project go to citrineos.github.io.

Prerequisites

Before you begin, make sure you have the following installed on your system:

• Node.js (v18 or higher): Download Node.js
• npm (Node Package Manager): Download npm
• Docker (Optional). Version >= 20.10: Download Docker

Installation

1. Clone the CitrineOS repository to your local machine:

   git clone https://github.com/citrineos/citrineos-core

2. Install project dependencies from root dir:

   npm run install-all

3. Build project from root dir:

   npm run build

4. The docker container should be initialized from cd /Server by running docker-compose -f ./docker-compose.yml up -d or by using the IntelliJ Server Run Configuration which was created for this purpose.

5. Running docker-compose.yml will ensure that the container is configured to expose the :9229 debugging port for the underlying NodeJS process. A variety of tools can be utilized to establish a debugger connection with the exposed localhost 9229 port which is forwarded to the NodeJS service running within docker. The IntelliJ Attach Debugger Run Configuration was made to attach to a debugging session.

Starting the Server without Docker

CitrineOS requires configuration to allow your OCPP 2.0.1 compliant charging stations to connect.

We recommend running and developing the project with the docker-compose set-up via the existing Run Configurations. Additional Run Configurations should be made for other IDEs (ex VSCode).

To change necessary configuration for execution outside of docker-compose, please adjust the configuration file at Server/src/config/envs/local.ts. Make sure any changes to the local configuration do not make it into your PR.

Starting the Server

To start the CitrineOS server, run the following command:

cd Server
npm run start

This will launch the CitrineOS server with the specified configuration. The debugger will be available on port 9229.

Attaching Debugger

Whether you run the application with Docker or locally with npm, you should be able to attach a debugger. With debugger attached you should be able to set breakpoints in the TS code right from your IDE and debug with ease.

Attaching Debugger before execution using --inspect-brk

You can modify nodemon.json exec command from:

npm run build --prefix ../ && node --inspect=0.0.0.0:9229 ./dist/index.js

to

npm run build --prefix ../ && node --inspect-brk=0.0.0.0:9229 ./dist/index.js

which will wait for the debugger to attach before proceeding with execution.

Usage

You can now connect your OCPP 2.0.1 compliant charging stations to the CitrineOS server. Make sure to configure the charging stations to point to the server's IP address and port as specified in the config.json file.

Testing with EVerest

This README

Running clean and fresh

Our current module structure consists of multiple npm submodules that are loaded as dependencies running the application. This results in the need to rebuild modules that have any file changes. In some cases, in particular when switching between branches, especially when there are changes in the package.json, the already built dist as well as the already generated package-lock.json may become invalid.

To alleviate the above, we created the npm run fresh and the npm run clean commands.

npm run fresh - will delete all node_modules, dist, tsbuildinfo, package-lock.json and clear cache npm run clean - sub set of npm run fresh will only delete the build files dist and tsbuildinfo

Linting and Prettier

Eslint and Prettier have been configured to help support syntactical consistency throughout the codebase.

npm run prettier - will run prettier and format the files npm run lint - will run linter npm run lint-fix - will run prettier and linter -fix flag which will attempt to resolve any linting issues.

Information on Docker setup

You need to install docker (>= 20.10) and docker-compose. Furthermore, Visual Studio Code might be handy as a common integrated development environment.

Once Docker is running, the following services should be available:

• CitrineOS (service name: citrineos) with ports
  • 8080: webserver http - Swagger
  • 8081: websocket server tcp connection without auth
  • 8082: websocket server tcp connection with basic http auth
• RabbitMQ Broker (service name: amqp-broker) with ports
  • 5672: amqp tcp connection
  • 15672: RabbitMQ management interface
• PostgreSQL (service name: ocpp-db), PostgreSQL database for persistence
  • 5432: sql tcp connection
• Directus (service name: directus) on port 8055 with endpoints
  • :8055/admin: web interface (login = admin@citrineos.com:CitrineOS!)

These three services are defined in docker-compose.yml and they live inside the docker network docker_default with their respective ports. By default these ports are directly accessible by using localhost:8080 for example.

So, if you want to access the amqp-broker default management port via your localhost, you need to access localhost:15672.

Generating OCPP Interfaces

All CitrineOS interfaces for OCPP 2.0.1-defined schemas were procedurally generated using the script in 00_Base/json-schema-processor.js. It can be rerun:

npm run generate-interfaces -- ../../Path/To/OCPP-2.0.1_part3_JSON_schemas

This will replace all the files in 00_Base/src/ocpp/model/,

Contributing

We welcome contributions from the community. If you would like to contribute to CitrineOS, please follow our contribution guidelines.

Licensing

CitrineOS and its subprojects are licensed under the Apache License, Version 2.0. See LICENSE for the full license text.

Support and Contact

If you have any questions or need assistance, feel free to reach out to us on our community forum or create an issue on the GitHub repository.

Roadmap

Roadmap