Add doc build snapshot nightly

EVerest · Sep 8, 2023 · 814ee38 · 814ee38
1 parent 69b65cc
commit 814ee38
Show file tree

Hide file tree

Showing 18 changed files with 174 additions and 52 deletions.
diff --git a/docs/latest/_generated/interfaces/evse_manager.html b/docs/latest/_generated/interfaces/evse_manager.html
@@ -225,14 +225,6 @@ <h2><span class="section-number">10.2.15.2. </span>Commands<a class="headerlink"
 <div class="line"><strong>There is an extended definition for this object</strong> <a class="reference internal" href="../types/evse_manager.html#evse-manager-switchthreephaseswhilechargingresult"><span class="std std-ref">here</span></a>.</div>
 </div>
 </div>
-<div class="line"><strong>get_signed_meter_value</strong>:<em>string</em></div>
-<div class="line-block">
-<div class="line">Returns a signed meter value. Includes current id_token if session is running.</div>
-<div class="line"><strong>Result</strong>:<em>string</em></div>
-<div class="line-block">
-<div class="line">Signed meter value</div>
-</div>
-</div>
 <div class="line"><strong>set_get_certificate_response</strong>:<em>void</em></div>
 <div class="line-block">
 <div class="line">CertificateInstallationRes/CertificateUpdateRes - Set the new/updated Contract Certificate (including the certificate chain) and the corresponding encrypted private key. Should be forwared to EVCC. This is an async response to a previously published iso15118_certificate_request</div>

diff --git a/docs/latest/_generated/interfaces/powermeter.html b/docs/latest/_generated/interfaces/powermeter.html
@@ -60,16 +60,29 @@ <h2><span class="section-number">10.2.24.1. </span>Variables<a class="headerlink
 <section id="commands">
 <h2><span class="section-number">10.2.24.2. </span>Commands<a class="headerlink" href="#commands" title="Permalink to this heading">¶</a></h2>
 <div class="line-block">
-<div class="line"><strong>get_signed_meter_value</strong>:<em>string</em></div>
+<div class="line"><strong>start_transaction</strong>:<em>boolean</em></div>
 <div class="line-block">
-<div class="line">Returns a signed meter value with the given auth token</div>
-<div class="line"><strong>auth_token</strong>:<em>string</em></div>
+<div class="line">Starts a transaction on the power meter (for signed metering according to German Eichrecht)</div>
+<div class="line"><strong>value</strong>:<em>object</em> (<a class="reference internal" href="../types/powermeter.html#powermeter-transactionreq"><span class="std std-ref">powermeter-TransactionReq</span></a>)</div>
 <div class="line-block">
-<div class="line">Auth token</div>
+<div class="line">All information that should be included in the signed OCMF packet</div>
+<div class="line"><strong>There is an extended definition for this object</strong> <a class="reference internal" href="../types/powermeter.html#powermeter-transactionreq"><span class="std std-ref">here</span></a>.</div>
+</div>
+<div class="line"><strong>Result</strong>:<em>boolean</em></div>
+<div class="line-block">
+<div class="line">True on success, False if transaction could not be started in the power meter</div>
+</div>
+</div>
+<div class="line"><strong>stop_transaction</strong>:<em>string</em></div>
+<div class="line-block">
+<div class="line">Stop the transaction on the power meter and return the signed metering information</div>
+<div class="line"><strong>transaction_id</strong>:<em>string</em></div>
+<div class="line-block">
+<div class="line">Transaction id</div>
 </div>
 <div class="line"><strong>Result</strong>:<em>string</em></div>
 <div class="line-block">
-<div class="line">Signed meter value</div>
+<div class="line">Returns OCMF signed meter values</div>
 </div>
 </div>
 </div>

diff --git a/docs/latest/_generated/types/powermeter.html b/docs/latest/_generated/types/powermeter.html
@@ -45,6 +45,40 @@ <h3>Navigation</h3>
   <section id="powermeter">
 <span id="everest-types-powermeter"></span><h1><span class="section-number">10.3.11. </span>powermeter<a class="headerlink" href="#powermeter" title="Permalink to this heading">¶</a></h1>
 <p>Powermeter types</p>
+<div class="line-block" id="powermeter-transactionreq">
+<div class="line"><strong>TransactionReq</strong>:<em>object</em></div>
+<div class="line-block">
+<div class="line">Required input parameter for starting an OCMF transaction. These values will be included in the signed OCMF packet.</div>
+<div class="line">required: evse_id, transaction_id, client_id, tariff_id, cable_id, user_data</div>
+<div class="line">properties:</div>
+<div class="line-block">
+<div class="line"><strong>evse_id</strong>:<em>string</em></div>
+<div class="line-block">
+<div class="line">Id of this EVSE</div>
+</div>
+<div class="line"><strong>transaction_id</strong>:<em>string</em></div>
+<div class="line-block">
+<div class="line">OCPP transaction UUID</div>
+</div>
+<div class="line"><strong>client_id</strong>:<em>string</em></div>
+<div class="line-block">
+<div class="line">User identification means, e.g. RFID card ID</div>
+</div>
+<div class="line"><strong>tariff_id</strong>:<em>string</em></div>
+<div class="line-block">
+<div class="line">Tariff ID</div>
+</div>
+<div class="line"><strong>cable_id</strong>:<em>string</em></div>
+<div class="line-block">
+<div class="line">Cable ID</div>
+</div>
+<div class="line"><strong>user_data</strong>:<em>string</em></div>
+<div class="line-block">
+<div class="line">User data</div>
+</div>
+</div>
+</div>
+</div>
 <div class="line-block" id="powermeter-powermeter">
 <div class="line"><strong>Powermeter</strong>:<em>object</em></div>
 <div class="line-block">

diff --git a/docs/latest/_sources/_generated/interfaces/evse_manager.rst.txt b/docs/latest/_sources/_generated/interfaces/evse_manager.rst.txt
@@ -108,10 +108,6 @@ Commands
 |  **Result**:*string* (:ref:`evse_manager-SwitchThreePhasesWhileChargingResult <evse_manager-SwitchThreePhasesWhileChargingResult>`)
 |   Returns success or error code
 |   **There is an extended definition for this object** :ref:`here <evse_manager-SwitchThreePhasesWhileChargingResult>`.
-| **get_signed_meter_value**:*string*
-|  Returns a signed meter value. Includes current id_token if session is running.
-|  **Result**:*string*
-|   Signed meter value
 | **set_get_certificate_response**:*void*
 |  CertificateInstallationRes/CertificateUpdateRes - Set the new/updated Contract Certificate (including the certificate chain) and the corresponding encrypted private key. Should be forwared to EVCC. This is an async response to a previously published iso15118_certificate_request
 |  **certificate_reponse**:*object* (:ref:`iso15118_charger-Response_Exi_Stream_Status <iso15118_charger-Response_Exi_Stream_Status>`)

diff --git a/docs/latest/_sources/_generated/interfaces/powermeter.rst.txt b/docs/latest/_sources/_generated/interfaces/powermeter.rst.txt
@@ -19,9 +19,16 @@ Variables
 ********
 Commands
 ********
-| **get_signed_meter_value**:*string*
-|  Returns a signed meter value with the given auth token
-|  **auth_token**:*string*
-|   Auth token
+| **start_transaction**:*boolean*
+|  Starts a transaction on the power meter (for signed metering according to German Eichrecht)
+|  **value**:*object* (:ref:`powermeter-TransactionReq <powermeter-TransactionReq>`)
+|   All information that should be included in the signed OCMF packet
+|   **There is an extended definition for this object** :ref:`here <powermeter-TransactionReq>`.
+|  **Result**:*boolean*
+|   True on success, False if transaction could not be started in the power meter
+| **stop_transaction**:*string*
+|  Stop the transaction on the power meter and return the signed metering information
+|  **transaction_id**:*string*
+|   Transaction id
 |  **Result**:*string*
-|   Signed meter value
+|   Returns OCMF signed meter values
diff --git a/docs/latest/_sources/_generated/types/powermeter.rst.txt b/docs/latest/_sources/_generated/types/powermeter.rst.txt
@@ -8,6 +8,25 @@ powermeter
 
 Powermeter types
 
+.. _powermeter-TransactionReq:
+
+| **TransactionReq**:*object*
+|  Required input parameter for starting an OCMF transaction. These values will be included in the signed OCMF packet.
+|  required: evse_id, transaction_id, client_id, tariff_id, cable_id, user_data
+|  properties:
+|   **evse_id**:*string*
+|    Id of this EVSE
+|   **transaction_id**:*string*
+|    OCPP transaction UUID
+|   **client_id**:*string*
+|    User identification means, e.g. RFID card ID
+|   **tariff_id**:*string*
+|    Tariff ID
+|   **cable_id**:*string*
+|    Cable ID
+|   **user_data**:*string*
+|    User data
+
 .. _powermeter-Powermeter:
 
 | **Powermeter**:*object*

diff --git a/docs/latest/appendix/02_snapshot.html b/docs/latest/appendix/02_snapshot.html
@@ -56,8 +56,8 @@ <h3>Navigation</h3>
 <span class="w">  </span><span class="nt">git_tag</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">main</span>
 <span class="nt">everest-core</span><span class="p">:</span>
 <span class="w">  </span><span class="nt">git</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">git@github.com:EVerest/everest-core.git</span>
-<span class="w">  </span><span class="nt">git_rev</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">a1857f2b045d0ecdea4dd42dffd0734a991572a7</span>
-<span class="w">  </span><span class="nt">git_tag</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">2023.8.0</span>
+<span class="w">  </span><span class="nt">git_rev</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">a84b51b61b0b900e57e5dfa17e25d628fcf3a7e6</span>
+<span class="w">  </span><span class="nt">git_tag</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">main</span>
 <span class="nt">everest-framework</span><span class="p">:</span>
 <span class="w">  </span><span class="nt">git</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://github.com/EVerest/everest-framework.git</span>
 <span class="w">  </span><span class="nt">git_rev</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">0a3d60e8d895a2bd702782ee7bc059f237b7c9a8</span>
@@ -68,7 +68,7 @@ <h3>Navigation</h3>
 <span class="w">  </span><span class="nt">git_tag</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v0.1.4</span>
 <span class="nt">everest.github.io</span><span class="p">:</span>
 <span class="w">  </span><span class="nt">git</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">git@github.com:everest/everest.github.io.git</span>
-<span class="w">  </span><span class="nt">git_rev</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">6822147a4a347aa814fd40be5fba922a315986b1</span>
+<span class="w">  </span><span class="nt">git_rev</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">69b65cc5e1c844a0e2e903ae8d4ce969b9a73b77</span>
 <span class="nt">ext-mbedtls</span><span class="p">:</span>
 <span class="w">  </span><span class="nt">git</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://github.com/EVerest/ext-mbedtls.git</span>
 <span class="w">  </span><span class="nt">git_rev</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">8b3f26a5ac38d4fdccbc5c5366229f3e01dafcc0</span>

diff --git a/docs/latest/objects.inv b/docs/latest/objects.inv
diff --git a/docs/latest/searchindex.js b/docs/latest/searchindex.js
diff --git a/docs/nightly/_generated/interfaces/evse_manager.html b/docs/nightly/_generated/interfaces/evse_manager.html
@@ -225,14 +225,6 @@ <h2><span class="section-number">10.2.15.2. </span>Commands<a class="headerlink"
 <div class="line"><strong>There is an extended definition for this object</strong> <a class="reference internal" href="../types/evse_manager.html#evse-manager-switchthreephaseswhilechargingresult"><span class="std std-ref">here</span></a>.</div>
 </div>
 </div>
-<div class="line"><strong>get_signed_meter_value</strong>:<em>string</em></div>
-<div class="line-block">
-<div class="line">Returns a signed meter value. Includes current id_token if session is running.</div>
-<div class="line"><strong>Result</strong>:<em>string</em></div>
-<div class="line-block">
-<div class="line">Signed meter value</div>
-</div>
-</div>
 <div class="line"><strong>set_get_certificate_response</strong>:<em>void</em></div>
 <div class="line-block">
 <div class="line">CertificateInstallationRes/CertificateUpdateRes - Set the new/updated Contract Certificate (including the certificate chain) and the corresponding encrypted private key. Should be forwared to EVCC. This is an async response to a previously published iso15118_certificate_request</div>

diff --git a/docs/nightly/_generated/interfaces/powermeter.html b/docs/nightly/_generated/interfaces/powermeter.html
@@ -60,16 +60,29 @@ <h2><span class="section-number">10.2.24.1. </span>Variables<a class="headerlink
 <section id="commands">
 <h2><span class="section-number">10.2.24.2. </span>Commands<a class="headerlink" href="#commands" title="Permalink to this heading">¶</a></h2>
 <div class="line-block">
-<div class="line"><strong>get_signed_meter_value</strong>:<em>string</em></div>
+<div class="line"><strong>start_transaction</strong>:<em>boolean</em></div>
 <div class="line-block">
-<div class="line">Returns a signed meter value with the given auth token</div>
-<div class="line"><strong>auth_token</strong>:<em>string</em></div>
+<div class="line">Starts a transaction on the power meter (for signed metering according to German Eichrecht)</div>
+<div class="line"><strong>value</strong>:<em>object</em> (<a class="reference internal" href="../types/powermeter.html#powermeter-transactionreq"><span class="std std-ref">powermeter-TransactionReq</span></a>)</div>
 <div class="line-block">
-<div class="line">Auth token</div>
+<div class="line">All information that should be included in the signed OCMF packet</div>
+<div class="line"><strong>There is an extended definition for this object</strong> <a class="reference internal" href="../types/powermeter.html#powermeter-transactionreq"><span class="std std-ref">here</span></a>.</div>
+</div>
+<div class="line"><strong>Result</strong>:<em>boolean</em></div>
+<div class="line-block">
+<div class="line">True on success, False if transaction could not be started in the power meter</div>
+</div>
+</div>
+<div class="line"><strong>stop_transaction</strong>:<em>string</em></div>
+<div class="line-block">
+<div class="line">Stop the transaction on the power meter and return the signed metering information</div>
+<div class="line"><strong>transaction_id</strong>:<em>string</em></div>
+<div class="line-block">
+<div class="line">Transaction id</div>
 </div>
 <div class="line"><strong>Result</strong>:<em>string</em></div>
 <div class="line-block">
-<div class="line">Signed meter value</div>
+<div class="line">Returns OCMF signed meter values</div>
 </div>
 </div>
 </div>

diff --git a/docs/nightly/_generated/types/powermeter.html b/docs/nightly/_generated/types/powermeter.html
@@ -45,6 +45,40 @@ <h3>Navigation</h3>
   <section id="powermeter">
 <span id="everest-types-powermeter"></span><h1><span class="section-number">10.3.11. </span>powermeter<a class="headerlink" href="#powermeter" title="Permalink to this heading">¶</a></h1>
 <p>Powermeter types</p>
+<div class="line-block" id="powermeter-transactionreq">
+<div class="line"><strong>TransactionReq</strong>:<em>object</em></div>
+<div class="line-block">
+<div class="line">Required input parameter for starting an OCMF transaction. These values will be included in the signed OCMF packet.</div>
+<div class="line">required: evse_id, transaction_id, client_id, tariff_id, cable_id, user_data</div>
+<div class="line">properties:</div>
+<div class="line-block">
+<div class="line"><strong>evse_id</strong>:<em>string</em></div>
+<div class="line-block">
+<div class="line">Id of this EVSE</div>
+</div>
+<div class="line"><strong>transaction_id</strong>:<em>string</em></div>
+<div class="line-block">
+<div class="line">OCPP transaction UUID</div>
+</div>
+<div class="line"><strong>client_id</strong>:<em>string</em></div>
+<div class="line-block">
+<div class="line">User identification means, e.g. RFID card ID</div>
+</div>
+<div class="line"><strong>tariff_id</strong>:<em>string</em></div>
+<div class="line-block">
+<div class="line">Tariff ID</div>
+</div>
+<div class="line"><strong>cable_id</strong>:<em>string</em></div>
+<div class="line-block">
+<div class="line">Cable ID</div>
+</div>
+<div class="line"><strong>user_data</strong>:<em>string</em></div>
+<div class="line-block">
+<div class="line">User data</div>
+</div>
+</div>
+</div>
+</div>
 <div class="line-block" id="powermeter-powermeter">
 <div class="line"><strong>Powermeter</strong>:<em>object</em></div>
 <div class="line-block">

diff --git a/docs/nightly/_sources/_generated/interfaces/evse_manager.rst.txt b/docs/nightly/_sources/_generated/interfaces/evse_manager.rst.txt
@@ -108,10 +108,6 @@ Commands
 |  **Result**:*string* (:ref:`evse_manager-SwitchThreePhasesWhileChargingResult <evse_manager-SwitchThreePhasesWhileChargingResult>`)
 |   Returns success or error code
 |   **There is an extended definition for this object** :ref:`here <evse_manager-SwitchThreePhasesWhileChargingResult>`.
-| **get_signed_meter_value**:*string*
-|  Returns a signed meter value. Includes current id_token if session is running.
-|  **Result**:*string*
-|   Signed meter value
 | **set_get_certificate_response**:*void*
 |  CertificateInstallationRes/CertificateUpdateRes - Set the new/updated Contract Certificate (including the certificate chain) and the corresponding encrypted private key. Should be forwared to EVCC. This is an async response to a previously published iso15118_certificate_request
 |  **certificate_reponse**:*object* (:ref:`iso15118_charger-Response_Exi_Stream_Status <iso15118_charger-Response_Exi_Stream_Status>`)

diff --git a/docs/nightly/_sources/_generated/interfaces/powermeter.rst.txt b/docs/nightly/_sources/_generated/interfaces/powermeter.rst.txt
@@ -19,9 +19,16 @@ Variables
 ********
 Commands
 ********
-| **get_signed_meter_value**:*string*
-|  Returns a signed meter value with the given auth token
-|  **auth_token**:*string*
-|   Auth token
+| **start_transaction**:*boolean*
+|  Starts a transaction on the power meter (for signed metering according to German Eichrecht)
+|  **value**:*object* (:ref:`powermeter-TransactionReq <powermeter-TransactionReq>`)
+|   All information that should be included in the signed OCMF packet
+|   **There is an extended definition for this object** :ref:`here <powermeter-TransactionReq>`.
+|  **Result**:*boolean*
+|   True on success, False if transaction could not be started in the power meter
+| **stop_transaction**:*string*
+|  Stop the transaction on the power meter and return the signed metering information
+|  **transaction_id**:*string*
+|   Transaction id
 |  **Result**:*string*
-|   Signed meter value
+|   Returns OCMF signed meter values
diff --git a/docs/nightly/_sources/_generated/types/powermeter.rst.txt b/docs/nightly/_sources/_generated/types/powermeter.rst.txt
@@ -8,6 +8,25 @@ powermeter
 
 Powermeter types
 
+.. _powermeter-TransactionReq:
+
+| **TransactionReq**:*object*
+|  Required input parameter for starting an OCMF transaction. These values will be included in the signed OCMF packet.
+|  required: evse_id, transaction_id, client_id, tariff_id, cable_id, user_data
+|  properties:
+|   **evse_id**:*string*
+|    Id of this EVSE
+|   **transaction_id**:*string*
+|    OCPP transaction UUID
+|   **client_id**:*string*
+|    User identification means, e.g. RFID card ID
+|   **tariff_id**:*string*
+|    Tariff ID
+|   **cable_id**:*string*
+|    Cable ID
+|   **user_data**:*string*
+|    User data
+
 .. _powermeter-Powermeter:
 
 | **Powermeter**:*object*