Skip to content

Latest commit

 

History

History
178 lines (114 loc) · 5.23 KB

README.md

File metadata and controls

178 lines (114 loc) · 5.23 KB
Raw

rust-ocpp

crates.io workflow codecov

The rust-ocpp libs implements the Open Charge Point Protocol used in charging stations. You can read more on the official Open Charge Alliance website.

Both OCPP v1.6 and v2.0.1 are implemented and validated using the official json schemas from Open Charge Alliance.

You can find the tests in schema_validation.rs for both v.1.6 and v2.0.1

repo structure

src/ : library files for v1.6 and v2.0.1

docs/ : official ocpp specification

How to Use

Add rust-ocpp as a dependency in your Cargo.toml. It will default to version 2.0.1 of OCPP.

[dependencies]
rust-ocpp = "1.0"

To use 1.6 you need to specify a protocol version with a feature flag:

[dependencies]
rust-ocpp = { version = "1.0", features = ["v1_6"] }

or use both versions

[dependencies]
rust-ocpp = { version = "1.0", features = ["v2_0_1", "v1_6"] }

How to Build

To build the rust-ocpp library, you need to have Rust and Cargo installed on your system. You can install them by following the instructions provided at the official Rust website.

Once you have Rust and Cargo installed, you can build the library using the following steps:

  1. Clone the rust-ocpp repository:

    git clone https://github.com/codelabsab/rust-ocpp.git

  2. Change into the rust-ocpp directory:

    cd rust-ocpp

  3. Build the library using Cargo for both 1.6 and 2.0.1:

    cargo build --all-features

    This command will compile the library and its dependencies. If the build is successful, you will find the compiled artifacts in the target/debug directory.

  4. Run the tests on both versions:

    cargo test --all-features

    This command will execute the tests for both OCPP versions. If all tests pass, it means that the library is functioning correctly.

  5. Build a specific version:

    To build a specific version of rust-ocpp, you can use the appropriate feature flag when running the build command. For example, to build v1_6:

    cargo build --features v1_6

    To build v2_0_1:

    cargo build --features v2_0_1

  6. (Optional) Build for release:

    If you want to build the library for release, with optimizations enabled, you can use the following command:

    cargo build --features v2_0_1 --release

    The release build will produce optimized artifacts in the target/release directory.

  7. (Optional) Install the library:

    If you want to install the library globally on your system, you can use the following command:

    cargo install --path .

    This command will compile the library and its dependencies and install it in the Cargo binary directory, so you can use it as a dependency in other projects.

That's it! You have successfully built the rust-ocpp library. If you encounter any issues during the build process, please check the project's issue tracker on GitHub or open a new issue for assistance.

Testing

rust-ocpp provides testing against json schemas for both OCPP v1.6 and v2.0.1 versions. To run the tests, you can use Cargo's built-in test runner.

Running Tests

To run the tests for a specific version, use the appropriate feature flag when running the tests.

For OCPP v1.6 tests:

cargo test --features v1_6

For OCPP v2.0.1 tests:

cargo test --features v2_0_1

To run all tests:

cargo test

or for a specific version

cargo test --features v1_6

Test Coverage

The test coverage for rust-ocpp is measured using Codecov. You can find the current test coverage report on codecov.

Contributing to Tests

Contributions to the test suite are very much appreciated. If you encounter any bugs, discover edge cases, or have ideas for additional test cases, feel free to open an issue or submit a pull request. We will be happy to review and incorporate your contributions.

Please ensure that you run the tests and maintain or improve the overall test coverage before submitting any changes. Additionally, adhere to the existing testing conventions and follow the code style guidelines to maintain consistency.

Contribute

Use rustfmt before you PR.

pre-commit config is available. You can read more about it at pre-commits website and checkout their repo on github

Releasing a new version

  1. Update the version of the library and push the changes to the main branch.
  2. Create a new release on GitHub with the new version number and some release notes (optional).

This will trigger the publish workflow which will publish the new version to crates.io.