ocpi-tariffs-cli 0.2.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


# OCPI tariffs CLI

This crate provides a binary for doing calculations with [OCPI][ocpi]
[tariffs][tariffs]. Specifically for the [`OCPI 2.2.1`](https://evroaming.org/app/uploads/2021/11/OCPI-2.2.1.pdf)
version.

## Installation

```ignore
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

#### Analyze

To price a tariff and CDR (Charge detail record) and see a breakdown of the separate periods use `analyze`:

```ignore
Analyze 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 analyze [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.

  -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')
```

#### Validate

To price a tariff and CDR and check if the calculation differs from the original CDR use `validate`:

```ignore
Validate 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 the differences between the calculated totals and the totals contained in the provided CDR.

Usage: ocpi-tariffs validate [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.

  -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')
```