Skip to content

Commit

Permalink
Add doc build snapshot nightly
Browse files Browse the repository at this point in the history
  • Loading branch information
pionix-compiler committed Dec 22, 2023
1 parent 40d165e commit 72e4378
Show file tree
Hide file tree
Showing 14 changed files with 302 additions and 16 deletions.
14 changes: 14 additions & 0 deletions docs/latest/_generated/interfaces/ocpp.html
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,20 @@ <h2><span class="section-number">11.2.22.2. </span>Commands<a class="headerlink"
</div>
</div>
</div>
<div class="line"><strong>change_availability</strong>:<em>object</em></div>
<div class="line-block">
<div class="line">Allows to send a ChangeAvailabilityRequest internally (as can be done by the CSMS).</div>
<div class="line"><strong>request</strong>:<em>object</em> (<a class="reference internal" href="../types/ocpp.html#ocpp-changeavailabilityrequest"><span class="std std-ref">ocpp-ChangeAvailabilityRequest</span></a>)</div>
<div class="line-block">
<div class="line">The ChangeAvailabilityRequest as specified in OCPP2.0.1. For OCPP 1.6:</div>
<div class="line"><strong>There is an extended definition for this object</strong> <a class="reference internal" href="../types/ocpp.html#ocpp-changeavailabilityrequest"><span class="std std-ref">here</span></a>.</div>
</div>
<div class="line"><strong>Result</strong>:<em>object</em> (<a class="reference internal" href="../types/ocpp.html#ocpp-changeavailabilityresponse"><span class="std std-ref">ocpp-ChangeAvailabilityResponse</span></a>)</div>
<div class="line-block">
<div class="line">Response to ChangeAvailabilityRequest as specified in OCPP 2.0.1</div>
<div class="line"><strong>There is an extended definition for this object</strong> <a class="reference internal" href="../types/ocpp.html#ocpp-changeavailabilityresponse"><span class="std std-ref">here</span></a>.</div>
</div>
</div>
<div class="line"><strong>monitor_variables</strong>:<em>void</em></div>
<div class="line-block">
<div class="line">Command to start monitoring the given ComponentVariable(s). Any of the provided configuration keys will be published on change by the CSMS. Consecutive calls of this operation will not override but extend the existing monitors. With OCPP1.6: This command can be used to monitor configuration keys With OCPP2.0.1: This command can be used to monitor any kind of variable in the device model storage</div>
Expand Down
72 changes: 72 additions & 0 deletions docs/latest/_generated/types/ocpp.html
Original file line number Diff line number Diff line change
Expand Up @@ -462,6 +462,78 @@ <h3>Navigation</h3>
</div>
</div>
</div>
<div class="line-block" id="ocpp-operationalstatusenumtype">
<div class="line"><strong>OperationalStatusEnumType</strong>:<em>string</em></div>
<div class="line-block">
<div class="line">Operational status of Charging Station /EVSE / Connector</div>
<div class="line">enum: Inoperative, Operative</div>
</div>
</div>
<div class="line-block" id="ocpp-changeavailabilityrequest">
<div class="line"><strong>ChangeAvailabilityRequest</strong>:<em>object</em></div>
<div class="line-block">
<div class="line">Request type to change the availability of the Charging Station/ an EVSE / a Connector.</div>
<div class="line">required: operational_status</div>
<div class="line">properties:</div>
<div class="line-block">
<div class="line"><strong>operational_status</strong>:<em>string</em> (<a class="reference internal" href="#ocpp-operationalstatusenumtype"><span class="std std-ref">ocpp-OperationalStatusEnumType</span></a>)</div>
<div class="line-block">
<div class="line">Type of availability change that the Charging Station should perform.</div>
<div class="line"><strong>There is an extended definition for this object</strong> <a class="reference internal" href="#ocpp-operationalstatusenumtype"><span class="std std-ref">here</span></a>.</div>
</div>
<div class="line"><strong>evse</strong>:<em>object</em> (<a class="reference internal" href="#ocpp-evse"><span class="std std-ref">ocpp-EVSE</span></a>)</div>
<div class="line-block">
<div class="line">Specify EVSE/Connector whose status is changed. When omitted, the message refers to the Charging Station as a whole.</div>
<div class="line"><strong>There is an extended definition for this object</strong> <a class="reference internal" href="#ocpp-evse"><span class="std std-ref">here</span></a>.</div>
</div>
</div>
</div>
</div>
<div class="line-block" id="ocpp-changeavailabilitystatusenumtype">
<div class="line"><strong>ChangeAvailabilityStatusEnumType</strong>:<em>string</em></div>
<div class="line-block">
<div class="line">Status returned in response to ChangeAvailabilityRequest.</div>
<div class="line">enum: Accepted, Rejected, Scheduled</div>
</div>
</div>
<div class="line-block" id="ocpp-statusinfotype">
<div class="line"><strong>StatusInfoType</strong>:<em>object</em></div>
<div class="line-block">
<div class="line">Element providing more information about the status.</div>
<div class="line">required: reason_code</div>
<div class="line">properties:</div>
<div class="line-block">
<div class="line"><strong>reason_code</strong>:<em>string</em></div>
<div class="line-block">
<div class="line">A predefined code for the reason why the status is returned in this response. The string is case-insensitive.</div>
</div>
<div class="line"><strong>additional_info</strong>:<em>string</em></div>
<div class="line-block">
<div class="line">Additional text to provide detailed information</div>
</div>
</div>
</div>
</div>
<div class="line-block" id="ocpp-changeavailabilityresponse">
<div class="line"><strong>ChangeAvailabilityResponse</strong>:<em>object</em></div>
<div class="line-block">
<div class="line">Response type to request to change the availability of the Charging Station/ an EVSE / a Connector.</div>
<div class="line">required: status</div>
<div class="line">properties:</div>
<div class="line-block">
<div class="line"><strong>status</strong>:<em>string</em> (<a class="reference internal" href="#ocpp-changeavailabilitystatusenumtype"><span class="std std-ref">ocpp-ChangeAvailabilityStatusEnumType</span></a>)</div>
<div class="line-block">
<div class="line">Indicates whether the Charging Station is able to perform the availability change.</div>
<div class="line"><strong>There is an extended definition for this object</strong> <a class="reference internal" href="#ocpp-changeavailabilitystatusenumtype"><span class="std std-ref">here</span></a>.</div>
</div>
<div class="line"><strong>status_info</strong>:<em>object</em> (<a class="reference internal" href="#ocpp-statusinfotype"><span class="std std-ref">ocpp-StatusInfoType</span></a>)</div>
<div class="line-block">
<div class="line">Detailed status information.</div>
<div class="line"><strong>There is an extended definition for this object</strong> <a class="reference internal" href="#ocpp-statusinfotype"><span class="std std-ref">here</span></a>.</div>
</div>
</div>
</div>
</div>
</section>


Expand Down
8 changes: 8 additions & 0 deletions docs/latest/_sources/_generated/interfaces/ocpp.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,14 @@ Commands
| items:
| type:
| $ref:
| **change_availability**:*object*
| Allows to send a ChangeAvailabilityRequest internally (as can be done by the CSMS).
| **request**:*object* (:ref:`ocpp-ChangeAvailabilityRequest <ocpp-ChangeAvailabilityRequest>`)
| The ChangeAvailabilityRequest as specified in OCPP2.0.1. For OCPP 1.6:
| **There is an extended definition for this object** :ref:`here <ocpp-ChangeAvailabilityRequest>`.
| **Result**:*object* (:ref:`ocpp-ChangeAvailabilityResponse <ocpp-ChangeAvailabilityResponse>`)
| Response to ChangeAvailabilityRequest as specified in OCPP 2.0.1
| **There is an extended definition for this object** :ref:`here <ocpp-ChangeAvailabilityResponse>`.
| **monitor_variables**:*void*
| Command to start monitoring the given ComponentVariable(s). Any of the provided configuration keys will be published on change by the CSMS. Consecutive calls of this operation will not override but extend the existing monitors. With OCPP1.6: This command can be used to monitor configuration keys With OCPP2.0.1: This command can be used to monitor any kind of variable in the device model storage
| **component_variables**:*array*
Expand Down
49 changes: 49 additions & 0 deletions docs/latest/_sources/_generated/types/ocpp.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -272,3 +272,52 @@ OCPP types (OCPP1.6 and OCPP2.0.1). The types are based more on the type definit
| If an event notification is linked to a specific transaction, this field can be used to specify its transactionId
| **variable_monitoring_id**:*integer*
| Identifies the VariableMonitoring which triggered the event
.. _ocpp-OperationalStatusEnumType:

| **OperationalStatusEnumType**:*string*
| Operational status of Charging Station /EVSE / Connector
| enum: Inoperative, Operative
.. _ocpp-ChangeAvailabilityRequest:

| **ChangeAvailabilityRequest**:*object*
| Request type to change the availability of the Charging Station/ an EVSE / a Connector.
| required: operational_status
| properties:
| **operational_status**:*string* (:ref:`ocpp-OperationalStatusEnumType <ocpp-OperationalStatusEnumType>`)
| Type of availability change that the Charging Station should perform.
| **There is an extended definition for this object** :ref:`here <ocpp-OperationalStatusEnumType>`.
| **evse**:*object* (:ref:`ocpp-EVSE <ocpp-EVSE>`)
| Specify EVSE/Connector whose status is changed. When omitted, the message refers to the Charging Station as a whole.
| **There is an extended definition for this object** :ref:`here <ocpp-EVSE>`.
.. _ocpp-ChangeAvailabilityStatusEnumType:

| **ChangeAvailabilityStatusEnumType**:*string*
| Status returned in response to ChangeAvailabilityRequest.
| enum: Accepted, Rejected, Scheduled
.. _ocpp-StatusInfoType:

| **StatusInfoType**:*object*
| Element providing more information about the status.
| required: reason_code
| properties:
| **reason_code**:*string*
| A predefined code for the reason why the status is returned in this response. The string is case-insensitive.
| **additional_info**:*string*
| Additional text to provide detailed information
.. _ocpp-ChangeAvailabilityResponse:

| **ChangeAvailabilityResponse**:*object*
| Response type to request to change the availability of the Charging Station/ an EVSE / a Connector.
| required: status
| properties:
| **status**:*string* (:ref:`ocpp-ChangeAvailabilityStatusEnumType <ocpp-ChangeAvailabilityStatusEnumType>`)
| Indicates whether the Charging Station is able to perform the availability change.
| **There is an extended definition for this object** :ref:`here <ocpp-ChangeAvailabilityStatusEnumType>`.
| **status_info**:*object* (:ref:`ocpp-StatusInfoType <ocpp-StatusInfoType>`)
| Detailed status information.
| **There is an extended definition for this object** :ref:`here <ocpp-StatusInfoType>`.
14 changes: 7 additions & 7 deletions docs/latest/appendix/02_snapshot.html
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,11 @@ <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">928f678</span>
<span class="nt">everest</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">[email protected]:EVerest/EVerest.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">2899e25fcb70c6330c346ae2c807480557c219e9</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">75f8b1f279bf2a8f30c68e0d2db96275bdf63b6b</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-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">[email protected]: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">b134559b1f6dad909d3b47309800e1b5ad8e8e68</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">b9c36fd8ac797b9aea98f8a249077293019d9f13</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>
Expand All @@ -66,7 +66,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">a054460</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">[email protected]: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">918ad72967d9a42e93a64603f3c8a05868b5faea</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">40d165e5d4ac9b445859e8a25551d275791576ae</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>
Expand All @@ -89,8 +89,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">v0.2.0</span>
<span class="nt">liblog</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/liblog.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">19dce0ec3afda8d61bb95a6455a79913b732ec44</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">v0.2.1</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">03b498407c6462af3f886aa2dab3e182a7f864c0</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">v0.1.0</span>
<span class="w"> </span><span class="nt">options</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">BUILD_EXAMPLES OFF</span>
<span class="nt">libmodbus</span><span class="p">:</span>
Expand All @@ -99,8 +99,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">v0.3.0</span>
<span class="nt">libocpp</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/libocpp.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">786528364064244ecefd8be3eeb45d638c878b1e</span>
<span class="w"> </span><span class="nt">git_tag</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;7865283&#39;</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">a6cd837e54af93d3c177cee3a45332ad8ea14095</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">a6cd837</span>
<span class="nt">libslac</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/libslac.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">486cd8b07e0654c2b5339d3ab40d07318967b7fd</span>
Expand Down
Binary file modified docs/latest/objects.inv
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/latest/searchindex.js

Large diffs are not rendered by default.

14 changes: 14 additions & 0 deletions docs/nightly/_generated/interfaces/ocpp.html
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,20 @@ <h2><span class="section-number">11.2.22.2. </span>Commands<a class="headerlink"
</div>
</div>
</div>
<div class="line"><strong>change_availability</strong>:<em>object</em></div>
<div class="line-block">
<div class="line">Allows to send a ChangeAvailabilityRequest internally (as can be done by the CSMS).</div>
<div class="line"><strong>request</strong>:<em>object</em> (<a class="reference internal" href="../types/ocpp.html#ocpp-changeavailabilityrequest"><span class="std std-ref">ocpp-ChangeAvailabilityRequest</span></a>)</div>
<div class="line-block">
<div class="line">The ChangeAvailabilityRequest as specified in OCPP2.0.1. For OCPP 1.6:</div>
<div class="line"><strong>There is an extended definition for this object</strong> <a class="reference internal" href="../types/ocpp.html#ocpp-changeavailabilityrequest"><span class="std std-ref">here</span></a>.</div>
</div>
<div class="line"><strong>Result</strong>:<em>object</em> (<a class="reference internal" href="../types/ocpp.html#ocpp-changeavailabilityresponse"><span class="std std-ref">ocpp-ChangeAvailabilityResponse</span></a>)</div>
<div class="line-block">
<div class="line">Response to ChangeAvailabilityRequest as specified in OCPP 2.0.1</div>
<div class="line"><strong>There is an extended definition for this object</strong> <a class="reference internal" href="../types/ocpp.html#ocpp-changeavailabilityresponse"><span class="std std-ref">here</span></a>.</div>
</div>
</div>
<div class="line"><strong>monitor_variables</strong>:<em>void</em></div>
<div class="line-block">
<div class="line">Command to start monitoring the given ComponentVariable(s). Any of the provided configuration keys will be published on change by the CSMS. Consecutive calls of this operation will not override but extend the existing monitors. With OCPP1.6: This command can be used to monitor configuration keys With OCPP2.0.1: This command can be used to monitor any kind of variable in the device model storage</div>
Expand Down
Loading

0 comments on commit 72e4378

Please sign in to comment.