ocpi-tariffs-cli 0.49.0

CLI application for OCPI tariff calculation
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103


# OCPI tariffs CLI

This crate provides a binary for doing calculations with
[OCPI](https://evroaming.org/ocpi-background/)
[tariffs](https://github.com/ocpi/ocpi/blob/2.2.1/mod_tariffs.asciidoc#1-tariffs-module).
Specifically for the [`OCPI 2.2.1`](https://evroaming.org/app/uploads/2021/11/OCPI-2.2.1.pdf) and
[`OCPI 2.1.1`](https://github.com/ocpi/ocpi/releases/download/2.1.1-d2/OCPI_2.1.1-d2.pdf) version.

## Installation

First install [Rust](https://www.rust-lang.org/tools/install) and then install
the OCPI tariffs command line tool:

```text
cargo install ocpi-tariffs-cli
```

## Usage

The binary can be directly executed using `ocpi-tariffs`. Execute `ocpi-tariffs
--help` for a list of subcommands.

### Subcomamands

#### Price

Use the `price` command to price a tariff and CDR (Charge detail record) and see a breakdown of the
periods and compare the CDR totals with the calculated:

```text
Price a given charge detail record (CDR) against either a provided tariff
structure or a tariff that is contained in the CDR itself.

This command will show you a breakdown of all the calculated costs.

Usage: ocpi-tariffs price [OPTIONS]

Options:
  -c, --cdr <CDR>
          A path to the charge detail record in json format.

          If no path is provided the CDR is read from standard in.

  -t, --tariff <TARIFF>
          A path to the tariff structure in json format.

          If no path is provided, then the tariff is inferred to be contained
          inside the provided CDR. If the CDR contains multiple tariff
          structures, the first valid tariff will be used.

  -o, --ocpi-version <OCPI_VERSION>
          The OCPI version that should be used for the input structures.

          If the input consists of version 2.1.1 structures they will be converted to 2.2.1 structures. 
          The actual calculation and output will always be according to OCPI 2.2.1.

          use `detect` to let to tool try to find the matching version.

          [default: v221]
          [possible values: v221, v211, detect]  


  -z, --timezone <TIMEZONE>
          Timezone for evaluating any local times contained in the tariff
          structure

          [default: Europe/Amsterdam]

  -h, --help
          Print help (see a summary with '-h')
```

#### Explain

Use the `explain` command to produce a human-language (English) explanation of what a tariff
charges and under which conditions. The explanation is written to standard out so it can be piped
or redirected; status messages and any warnings are written to standard error.

```text
Explain the given tariff in human language

Usage: ocpi-tariffs explain [OPTIONS] --ocpi-version <OCPI_VERSION>

Options:
  -o, --ocpi-version <OCPI_VERSION>
          The OCPI version that should be used for the input tariff

          Possible values:
          - v221: OCPI version 2.2.1
          - v211: OCPI version 2.1.1

      --pretty
          Pretty print the source tariff JSON before the explanation

  -f, --file <FILE>
          A path to the tariff structure in JSON format

          If no path is provided the tariff is read from standard in.

  -h, --help
          Print help (see a summary with '-h')
```