Package com.here.sdk.search

Class EVChargingLocation

java.lang.Object
com.here.NativeBase
com.here.sdk.search.EVChargingLocation
public final class EVChargingLocation extends NativeBase

An electric vehicle (EV) charging location.

The semantics generally follow the OCPI 2.2.1 standard.

Known EV-specific acronyms:

  • EV: Electric Vehicle
  • OCPI: Open Charge Point Interface (a standard with a rather wide adoption worldwide, https://evroaming.org/)
  • CPO: Charge Point Operator (company that runs the EV charging location)
  • eMSP: e-Mobility Service Provider (customer-facing company)
  • EVSE: Electric Vehicle Supply Equipment (the actual charger that can charge one car at a time)

A charging location includes a collection of one or more EV supply equipment (EVSE) instances. Typically, the charging location is the exact location of the group of EVSEs, simplified to a single point, but it can also be the entrance of a parking structure which contains these EVSEs. Each EVSE supports more precise position, where applicable.

Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

  • Method Details

    • getID

      @NonNull public String getID()

      Gets the unique identifier of the charging location.

      Returns:

      A unique identifier of the charging location.

    • getName

      @Nullable public String getName()

      Gets the display name of the charging location, if available.

      Returns:

      Display name of the charging location, if available.

    • getCpoID

      @Nullable public String getCpoID()

      Gets the CPO's own ID for the location.

      This ID may be relevant for some clients to map the charging location data to their own or 3rd party systems. Available only if EVChargingLocationFeature.LOCATION_INFO is included in EVSearchOptions.additional_features, otherwise null.

      Returns:

      CPO's own ID for the location.

    • getEvChargingOperator

      @Nullable public EVChargingOperator getEvChargingOperator()

      Gets the operator of the charging point, if available.

      Returns:

      Operator of the charging point, if available.

    • getEvChargingSubOperator

      @Nullable public EVChargingOperator getEvChargingSubOperator()

      Gets the suboperator of the charging point, if available.

      Returns:

      Suboperator of the charging point, if available.

    • getEMobilityServiceProviders

      @NonNull public List<EVChargingOperator> getEMobilityServiceProviders()

      Gets the list of eMSPs with a roaming agreement enabling access to the EV charging location.

      Available only if EVChargingLocationFeature.EMSPS is included in EVSearchOptions.additional_features, otherwise empty.

      Returns:

      eMSPs with a roaming agreement enabling access to the EV charging location.

    • getFacilityTypes

      @NonNull public List<FacilityType> getFacilityTypes()

      Gets the list of facilities available at the charging location, for example hotel, wifi, parking lot etc.

      Available only if EVChargingLocationFeature.NEARBY is included in EVSearchOptions.additional_features, otherwise empty.

      Returns:

      Facilities available at the charging location, for example hotel, wifi, parking lot etc.

    • getParkingType

      @Nullable public ParkingType getParkingType()

      Gets the type of parking at the charging location.

      Available only if EVChargingLocationFeature.LOCATION_INFO is included in EVSearchOptions.additional_features, otherwise null.

      Returns:

      The type of parking at the charging location.

    • getEnergyMix

      @Nullable public EnergyMix getEnergyMix()

      Gets the details on the energy supplied at the charging location.

      Returns:

      Details on the energy supplied at the charging location. Available only if EVChargingLocationFeature.LOCATION_INFO is included in EVSearchOptions.additional_features, otherwise null.

    • getEvses

      @NonNull public List<EVSEInfo> getEvses()

      Gets the list of EVSEs at the charging station.

      Available only if EVChargingLocationFeature.EVSES is included in EVSearchOptions.additional_features, otherwise empty.

      Returns:

      List of EVSEs at the charging station.

    • getTariffs

      @NonNull public List<EVChargingTariff> getTariffs()

      Gets the list of tariffs or price plans for the connectors of the charging station.

      Tariffs are typically connector-type specific. Hence, they are always linked with connectors and/or connector groups, by indexes to this list.

      This property is set only when data is available and when EVSearchOptions.additional_features include either EVChargingLocationFeature.EVSES or EVChargingLocationFeature.CONNECTOR_GROUPS.

      By default, the list includes tariffs for ad-hoc charging, per connector type, for EVSEs that accept payment without registering.

      Returns:

      List of tariffs or price plans for the connectors of the charging station.

    • getConnectorGroups

      @NonNull public List<EVChargingConnectorGroup> getConnectorGroups()

      Gets the connector groups for the location.

      Provides an overview of the charging connectors in the location by type and power. Available only if EVChargingLocationFeature.CONNECTOR_GROUPS is included in EVSearchOptions.additional_features, otherwise empty.

      Returns:

      Connector groups for the location.

    • getSupportedVehicles

      @NonNull public List<EVChargingVehicleCategory> getSupportedVehicles()

      Gets the list of vehicle categories this charging location can support. For example, the same location can be suitable for charging passenger cars and motorcycles.

      There may be some further restrictions specified in other attributes, for example the available connector types may not be suitable for all vehicles in the supported category.

      Returns:

      List of vehicle categories this charging location can support. For example, the same location can be suitable for charging passenger cars and motorcycles.

    • getTruckRestrictions

      @Nullable public EVChargingTruckRestriction getTruckRestrictions()

      Gets the access restrictions for trucks and light commercial vehicles.

      Restricted, only available to customers having a specific contract with HERE and if requested by including EVChargingLocationFeature.TRUCK_RESTRICTIONS in EVSearchOptions.additional_features, otherwise null.

      Returns:

      Access restrictions for trucks and light commercial vehicles.

    • getOpeningHours

      @Nullable public EVChargingOpeningHours getOpeningHours()

      Gets the times when the EVSEs at the charging location can be accessed for charging.

      Available only if EVChargingLocationFeature.LOCATION_INFO is included in EVSearchOptions.additional_features, otherwise null.

      Returns:

      The times when the EVSEs at the charging location can be accessed for charging.

    • getRestrictions

      @NonNull public List<EVAccessRestrictionReason> getRestrictions()

      Gets the list of restrictions.

      Returns:

      Reason(s) for restricted access.

    • getSupportPhoneNumber

      @Nullable public String getSupportPhoneNumber()

      Gets the phone number that EV drivers should call when need assistance at the charge location.

      Available only if EVChargingLocationFeature.LOCATION_INFO is included in EVSearchOptions.additional_features, otherwise null.

      Returns:

      The phone number that EV drivers should call when need assistance at the charge location, in E.164 format.

    • getTimeZone

      @Nullable public String getTimeZone()

      Gets the time zone of the charging location. Based on IANA tzdata's TZ-values.

      Available only if EVChargingLocationFeature.LOCATION_INFO is included in EVSearchOptions.additional_features, otherwise null.

      Returns:

      The time zone of the charging location. Based on IANA tzdata's TZ-values.