X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=README.md;h=1193489b64f325579618b914b6a7fc4c5b6c71a7;hb=aa711e399be6e394493fee4895b72eaf213df836;hp=274aac4a93c8e230437759b2844a0f72b10d91bf;hpb=738acbf767e776699e06239a63cb35558018fcc0;p=e-mobility-charging-stations-simulator.git diff --git a/README.md b/README.md index 274aac4a..1193489b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,11 @@ +
-# [e-mobility charging stations simulator](https://github.com/sap/e-mobility-charging-stations-simulator) +# [e-Mobility charging stations simulator](https://github.com/sap/e-mobility-charging-stations-simulator) + +
+ +
[![GitHub Clones](https://img.shields.io/badge/dynamic/json?color=brightgreen&label=Clone&query=count&url=https://gist.githubusercontent.com/jerome-benoit/c7c669b881d5b27dc0b44a639504ff93/raw/clone.json&logo=github)](https://github.com/SAP/e-mobility-charging-stations-simulator/graphs/traffic) [![GitHub commit activity (main)](https://img.shields.io/github/commit-activity/m/SAP/e-mobility-charging-stations-simulator/main?color=brightgreen&logo=github)](https://github.com/SAP/e-mobility-charging-stations-simulator/graphs/commit-activity) @@ -8,9 +13,12 @@ [![REUSE status](https://api.reuse.software/badge/github.com/SAP/e-mobility-charging-stations-simulator)](https://api.reuse.software/info/github.com/SAP/e-mobility-charging-stations-simulator) [![Javascript Standard Style Guide]()](https://standardjs.com) +
+ +Simple [node.js](https://nodejs.org/) software to simulate and scale a set of charging stations based on the OCPP-J protocol as part of [SAP e-Mobility](https://www.sap.com/products/scm/e-mobility.html) solution. + ## Table of contents -- [Summary](#summary) - [Installation](#installation) - [Prerequisites](#prerequisites) - [Windows](#windows) @@ -31,17 +39,13 @@ - [OCPP-J standard parameters supported](#ocpp-j-standard-parameters-supported) - [Version 1.6](#version-16-1) - [Version 2.x.x](#version-2xx-1) -- [UI protocol](#ui-protocol) +- [UI Protocol](#ui-protocol) - [Websocket Protocol](#websocket-protocol) - [HTTP Protocol](#http-protocol) - [Support, Feedback, Contributing](#support-feedback-contributing) - [Code of Conduct](#code-of-conduct) - [Licensing](#licensing) -## Summary - -Simple [node.js](https://nodejs.org/) software to simulate and scale a set of charging stations based on the OCPP-J protocol as part of [SAP e-Mobility](https://www.sap.com/products/scm/e-mobility.html) solution. - ## Installation ### Prerequisites @@ -88,11 +92,11 @@ pnpm install Copy the configuration template file [src/assets/config-template.json](./src/assets/config-template.json) to [src/assets/config.json](./src/assets/config.json). Copy the RFID tags template file [src/assets/idtags-template.json](./src/assets/idtags-template.json) to [src/assets/idtags.json](./src/assets/idtags.json). -Tweak them to your needs by following the section [configuration files syntax](./README.md#configuration-files-syntax): OCPP server supervision URL(s), charging station templates, etc. +Tweak them to your needs by following the section [configuration files syntax](#configuration-files-syntax): OCPP server supervision URL(s), charging station templates, etc. ## Start simulator -To start the program, run: `pnpm start`. +Run: `pnpm start`. ## Start Web UI @@ -529,7 +533,7 @@ All kind of OCPP parameters are supported in charging station configuration or c ### Version 2.x.x -## UI protocol +## UI Protocol Protocol to control the simulator via a Websocket or HTTP server: