Locations
The Locations module: how CPOs publish locations, EVSEs and connectors, and how the MOBI.Hub routes them to EMSPs.
On this page
Technical considerations
When a CPO creates or updates Location objects, MOBI.Hub shall route the information to the connected EMSPs by calling the corresponding Locations Receiver endpoint.
CPOs are autonomous in the creation and management of Locations in the MOBI.Hub. The MOBI.Hub shall ensure that the relevant information is routed to the EMSPs with an active interoperability relationship.
The number of GET requests may be limited per requesting entity and responses may be cached by MOBI.Hub.
The publication of a Location in the MOBI.Hub is at the discretion of the CPO. Any Location made available through the HUB may be shared with EMSPs according to the interoperability relationships configured in the platform.
For OCPI purposes, the relationship between a Location and a physical charging station is defined by the CPO. A CPO may consider each physical charging station as a separate Location or may group multiple charging stations located at the same site within a single Location, with each charging station represented as an EVSE_ID.
In the case of optional OCPI fields, MOBI.Hub does not ensure that they will be handled and shared with all entities.
For Location update timestamps, the latest update from any of the underlying EVSEs shall be considered.
MOBI.Hub shall support the date_from and date_to options on GET requests.
Methods to be implemented
EMSP (and MOBI.Hub)
| Method | Direction | Description of usage |
|---|---|---|
GET | Request | Responding with the status of a charging station |
PUT | Response | Pushing the creation of a new charging station |
PATCH | Response | Updating the status of an EVSE (including EOL or REMOVED) |
CPO (and MOBI.Hub)
| Method | Direction | Description of usage |
|---|---|---|
GET | Response | Receiving requests from external parties |
PUT | Request | Pushing the creation of a new charging station |
PATCH | Request | Updating the status of an EVSE (including EOL or REMOVED) |
The CPO must ensure the correct update of the status in real time.
Noted that for the UNKNOW status, the CPO must consider the cases where there are no heartbeats in the last 5 minutes and immediately after that, send a PATCH with the status update.
Objects definition
Location
Only the following properties shall be communicated:
| Property | Values | Mandatory | Comments |
|---|---|---|---|
country_code | PT | TRUE | Alpha-2 |
party_id | TRUE | ISO-15118 Codes to be defined by Mobi.e. [OPC] | |
id | TRUE | To be validated and issued by Mobi.e according to 0. | |
publish | true / false | TRUE | Please refer to paragraph 3.4.3.4 |
name | FALSE | The CPO is free to create a representative name for the location. Names will be shown in Portuguese. | |
address | TRUE | Street and house number | |
city | TRUE | City/municipality. Names shall be provided in Portuguese | |
country | PRT | TRUE | Alpha-3. Roaming is not supported within the interface as of Phase 1. |
postal_code | FALSE | ||
state | FALSE | ||
coordinates | TRUE | ||
parking_type |
| FALSE | |
evses | TRUE | ||
directions | FALSE | ||
operator | Only if CPO exists. Otherwise use generic name. | TRUE | |
suboperator | FALSE | ||
owner | FALSE | ||
facilities | (See List) | FALSE | |
time_zone |
| TRUE | |
opening_times | FALSE | ||
charging_when_closed | FALSE | ||
images | FALSE | ||
energy_mix | FALSE | ||
mobie_voltage_level | BTN / BTE / MT | FALSE | Specific from Mobi.e |
mobie_access_type | Public / Private | FALSE | Specific from Mobi.e |
mobie_cpe | FALSE | Specific from Mobi.e | |
last_updated | TRUE |
EVSE
| Property | Values | Mandatory | Comments |
|---|---|---|---|
uid | TRUE | internal number from CPO platform, it is advisable not to shown by apps | |
evse_id | TRUE | Country Code (2char) + Operator ID (3char) + ID Type (1char) + Unique Charging Point ID (1 to 30 char). Separators (*) are optional but recommended for a better human-readable version. Ex: PT*MOB*E222999 | |
Status |
| TRUE | |
Capabilities |
| TRUE | A CPO SHOULD always create an EVSE with the correct capabilities (to ensure that the charging station will be correctly used). |
Connectors | TRUE | ||
Floor_level | FALSE | ||
Coordinates | FALSE | ||
Physical_reference | FALSE | ||
Directions | FALSE | ||
Parking_restrictions | FALSE | ||
Images | FALSE | ||
last_updated | TRUE |
Please note that status “REMOVED” EVSE SHALL NOT be displayed by the EMSP to end-users.
Connector
| Property | Values | Mandatory | Comments |
|---|---|---|---|
id | TRUE | ||
standard |
| TRUE | |
format |
| TRUE | |
power_type |
| TRUE | |
max_voltage | 400 (example) | TRUE | In V |
max_amperage | 16 (example) | TRUE | In A |
max_electric_power | 22000 | FALSE | In W |
tariff_ids | TRUE | To be defined in the Tariffs Module | |
terms_and_conditions | TRUE | In particular, the terms and conditions shall include the precision level for DC measurement, if applicable. | |
last_updated | TRUE |
Considerations on “publish” property
When publish is FALSE, locations MUST NOT be shown in any time by the EMSP
EVSEs in PLANNED or REMOVED statuses MUST NOT be shown in any time by the EMSP regardless of their publish property.