Skip to content

MPH B2B and B2C Stop charge time #133

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
T0324L3 wants to merge 12 commits into
base: master
Choose a base branch
from
Open

MPH B2B and B2C Stop charge time #133

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
4d2d149
Enhance API schema with charging details
T0324L3 Nov 25, 2025
840b1d9
Enhance charge scheduling description in API spec
T0324L3 Nov 25, 2025
d45200e
Enhance API schema with charging end time details
T0324L3 Nov 25, 2025
b997f9d
Enhance API schema with charging end time and status
T0324L3 Nov 25, 2025
e1cf484
Enhance schedule description for charging modes
T0324L3 Nov 25, 2025
ef65ff5
Update api-b2c.yaml
T0324L3 Nov 25, 2025
8f0d89f
Add version 3.19.3 with Remote API updates
T0324L3 Nov 25, 2025
11579ad
Update changelog with new API versions
T0324L3 Nov 25, 2025
d949f58
Update charging schema with immediate property
T0324L3 Nov 25, 2025
5e55309
Update charging schema with immediate property
T0324L3 Nov 25, 2025
488846d
Update immediate property in api-b2c.yaml
T0324L3 Nov 25, 2025
2d9b591
Update immediate property in api-b2b.yaml
T0324L3 Nov 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion _data/webapi-b2b-changelog.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
- version: "3.19.3"
availability: in_use
release_date: 20 July 2025
description: |-
**Remote API**
- Added Stop charge status and Charge end time
- version: "3.19.2"
availability: in_use
release_date: 30 Jul 2024
Expand Down Expand Up @@ -566,4 +572,5 @@
description: |-
#### `1st release (B2B)`
* As delivered to Huawei regarding interfacing API
* As delivered to MPH/API team regarding public B2B API

* As delivered to MPH/API team regarding public B2B API
9 changes: 8 additions & 1 deletion _data/webapi-b2c-changelog.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
- version: "4.17.3"
availability: in_use
release_date: 10 Jul 2025
description: |-
**Remote API**
- Added Stop charge status and Charge end time
- version: "4.17.2"
availability: in_use
release_date: 30 Jul 2024
Expand Down Expand Up @@ -106,4 +112,5 @@
availability: not_in_use
release_date: 11 Apr 2019
description: |-
**First Release**

**First Release**
53 changes: 51 additions & 2 deletions assets/openapi/api-b2b.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1982,6 +1982,27 @@ components:
nextDelayedTime:
description: Duration (as defined in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)) until the next battery charging.
type: string
chargingEndTime:
description: Timestamp (as defined in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)) of when the charging should end
type: string
stopChargeStatus:
type: string
description: |
Status of delayed stop charge.
one of following enums status will be set:
| Enum | Description |
|----------|:-------------:|
| Deactivated | Function is deactivated |
| Activated | The function is activated, and the conditions to execute it are met. |
| Successful | The most recent stop charge was successful. |
| StopChargeFailed | Failed to stop charging. |
| ChargeEndTimeScheduleFailed| The programming of the end of charge failed; the charging should not stop at the requested time. |
enum:
- Deactivated
- Activated
- Successful
- StopChargeFailed
- ChargeEndTimeScheduleFailed
schedule:
properties:
programs:
Expand Down Expand Up @@ -3506,11 +3527,39 @@ components:
type: string
schedule:
type: object
description: Charge scheduling. Only one of the two modes, programs or nexDelayedTime, should be provided.
description: |
Charge scheduling: only one of the three modes, ```programs```, ```nextDelayedTime/immediate```, or ```chargingEndTime/chargingEndTimeEnabled```, should be provided.
* ```chargingEndTimeEnabled ```and ```chargingEndTime``` Can be used together to set the end time.
* ```nextDelayedTime``` and ```immediate``` cannot be used together and are mutually exclusive. Mixing them will result in an error (HTTP 400).
Here are the possible combinations of start and end times with their respective settings: immediate start and end time enable toggle.
* ```nextDelayedTime``` and ```immediate```
| <b>nextDelayedTime</b> | <b> immediate</b> |<b> allowed</b> |
| :------------------: | :-------------------: | :-------------------: |
| set |not set|yes |
| set |set to true/false|no |
| not set |set to true/false |yes |

* ```chargingEndTime``` and ```chargingEndTimeEnabled```
| <b>chargingEndTime</b> | <b> chargingEndTimeEnabled</b> |<b> allowed</b> |
| :------------------: | :-------------------: | :-------------------: |
| set |not set|yes |
| set |set to true / false|yes |
| not set |set to true/false |Yes, if the chargingEndTime has been set before; otherwise, it will raise an error (HTTP 400)|
* General rule: An empty schedule object will result in an error (HTTP 400).
properties:
nextDelayedTime:
type: string
description: Timestamp (as defined in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)) of the next battery charging time.
immediate:
type: boolean
description : Determines if the charging will start immediately(```True```) or not.
example : true
chargingEndTime:
type: string
description: Timestamp (as defined in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)) of when the charging should end
chargingEndTimeEnabled:
type: boolean
description: Enable or disable the programmed charge end time.
programs:
description: Scheduled charging programs list.
type: array
Expand Down Expand Up @@ -3539,7 +3588,7 @@ components:
example : PT14H30M
immediate:
type: boolean
description : Determines if the charging will start immediately(```True```) or not.
description : Determines if the charging will start immediately(```true```) or not.
example : true
preferences:
description: Set the charging preferences.
Expand Down
52 changes: 51 additions & 1 deletion assets/openapi/api-b2c.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2309,6 +2309,28 @@ components:
nextDelayedTime:
description: Duration (as defined in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)) until the next battery charging.
type: string
chargingEndTime:
type: string
description: Timestamp (as defined in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)) of when the charging should end
stopChargeStatus:
type: string
description: |
Status of delayed stop charge.
one of following enums status will be set:
| Enum | Description |
|----------|:-------------:|
| Deactivated | Function is deactivated |
| Activated | The function is activated, and the conditions to execute it are met. |
| Successful | The most recent stop charge was successful. |
| StopChargeFailed | Failed to stop charging. |
| ChargeEndTimeScheduleFailed| The programming of the end of charge failed; the charging should not stop at the requested time. |

enum:
- Deactivated
- Activated
- Successful
- StopChargeFailed
- ChargeEndTimeScheduleFailed
schedule:
properties:
programs:
Expand Down Expand Up @@ -4265,11 +4287,39 @@ components:
type: string
schedule:
type: object
description: Charge scheduling. Only one of the two modes, programs or nexDelayedTime, should be provided.
description: |
Charge scheduling: only one of the three modes, ```programs```, ```nextDelayedTime/immediate```, or ```chargingEndTime/chargingEndTimeEnabled```, should be provided.
* ```chargingEndTimeEnabled ```and ```chargingEndTime``` Can be used together to set the end time.
* ```nextDelayedTime``` and ```immediate``` cannot be used together and are mutually exclusive. Mixing them will result in an error (HTTP 400).
Here are the possible combinations of start and end times with their respective settings: immediate start and end time enable toggle.
* ```nextDelayedTime``` and ```immediate```
| <b>nextDelayedTime</b> | <b> immediate</b> |<b> allowed</b> |
| :------------------: | :-------------------: | :-------------------: |
| set |not set|yes |
| set |set to true/false|no |
| not set |set to true/false |yes |

* ```chargingEndTime``` and ```chargingEndTimeEnabled```
| <b>chargingEndTime</b> | <b> chargingEndTimeEnabled</b> |<b> allowed</b> |
| :------------------: | :-------------------: | :-------------------: |
| set |not set|yes |
| set |set to true / false|yes |
| not set |set to true/false |Yes, if the chargingEndTime has been set before; otherwise, it will raise an error (HTTP 400)|
* General rule: An empty schedule object will result in an error (HTTP 400).
properties:
nextDelayedTime:
type: string
description: Timestamp (as defined in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)) of the next battery charging time.
immediate:
type: boolean
description : Determines if the charging will start immediately(```True```) or not.
example : true
chargingEndTime:
type: string
description: Timestamp (as defined in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)) of when the charging should end
chargingEndTimeEnabled:
type: boolean
description: Enable or disable the programmed charge end time.
programs:
description: Scheduled charging programs list.
type: array
Expand Down