MOBI.Docs
Specification version: v1.0

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)

Locations methods for the EMSP (and MOBI.Hub)
MethodDirectionDescription of usage
GETRequestResponding with the status of a charging station
PUTResponsePushing the creation of a new charging station
PATCHResponseUpdating the status of an EVSE (including EOL or REMOVED)

CPO (and MOBI.Hub)

Locations methods for the CPO (and MOBI.Hub)
MethodDirectionDescription of usage
GETResponseReceiving requests from external parties
PUTRequestPushing the creation of a new charging station
PATCHRequestUpdating 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:

Table 1 – Location object properties
PropertyValuesMandatoryComments
country_codePTTRUEAlpha-2
party_idTRUEISO-15118 Codes to be defined by Mobi.e. [OPC]
idTRUETo be validated and issued by Mobi.e according to 0.
publishtrue / falseTRUEPlease refer to paragraph 3.4.3.4
nameFALSEThe CPO is free to create a representative name for the location. Names will be shown in Portuguese.
addressTRUEStreet and house number
cityTRUECity/municipality. Names shall be provided in Portuguese
countryPRTTRUEAlpha-3. Roaming is not supported within the interface as of Phase 1.
postal_codeFALSE
stateFALSE
coordinatesTRUE
parking_type
  • ALONG_MOTORWAY
  • PARKING_GARAGE
  • PARKING_LOT
  • ON_DRIVEWAY
  • ON_STREET
  • UNDERGROUND_GARAGE
FALSE
evsesTRUE
directionsFALSE
operatorOnly if CPO exists. Otherwise use generic name.TRUE
suboperatorFALSE
ownerFALSE
facilities(See List)FALSE
time_zone
  • Europe/Lisbon
  • Atlantic/Azores
TRUE
opening_timesFALSE
charging_when_closedFALSE
imagesFALSE
energy_mixFALSE
mobie_voltage_levelBTN / BTE / MTFALSESpecific from Mobi.e
mobie_access_typePublic / PrivateFALSESpecific from Mobi.e
mobie_cpeFALSESpecific from Mobi.e
last_updatedTRUE

EVSE

Table 2 – EVSE object properties
PropertyValuesMandatoryComments
uidTRUEinternal number from CPO platform, it is advisable not to shown by apps
evse_idTRUECountry 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
  • PLANNED
  • AVAILABLE [Idle]
  • CHARGING
  • INOPERATIVE
  • OUTOFORDER [OutOfService]
  • RESERVED [Reserved]
  • UNKNOWN [Unknown]
  • REMOVED [EndOfLife]
TRUE
Capabilities
  • REMOTE_START_STOP_CAPABLE
  • RFID_READER
TRUEA CPO SHOULD always create an EVSE with the correct capabilities (to ensure that the charging station will be correctly used).
ConnectorsTRUE
Floor_levelFALSE
CoordinatesFALSE
Physical_referenceFALSE
DirectionsFALSE
Parking_restrictionsFALSE
ImagesFALSE
last_updatedTRUE

Please note that status “REMOVED” EVSE SHALL NOT be displayed by the EMSP to end-users.

Connector

Table 3 – Connector object properties
PropertyValuesMandatoryComments
idTRUE
standard
  • CHADEMO
  • IEC_62196_T2
  • IEC_62196_T2_COMBO
TRUE
format
  • SOCKET
  • CABLE
TRUE
power_type
  • AC_1_PHASE
  • AC_3_PHASE
  • DC
TRUE
max_voltage400 (example)TRUEIn V
max_amperage16 (example)TRUEIn A
max_electric_power22000FALSEIn W
tariff_idsTRUETo be defined in the Tariffs Module
terms_and_conditionsTRUEIn particular, the terms and conditions shall include the precision level for DC measurement, if applicable.
last_updatedTRUE

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.