Developers Guide

Mark van den Bergh edited this page May 16, 2014 · 15 revisions

The Motown Platform comes with a number of Add-Ons, which can be configured into the system. In order to create your own eMobility system using Motown you will have to determine which Add-Ons apply to your situation.

The listing of components below describes each of the available Add-Ons. In case the default Add-Ons do not meet your needs, it is possible to [create your own custom Add-On](Creating a custom Add-On).

Components

Motown consists of several components. Each of these has their distinct part to play in a Motown system.

Motown overview

Component Role/purpose
Motown Core The basic blocks (core-api) that are to be used in other packages as well as the domain logic (command-handling) around the defined aggregates.
Operator API Add-on* Provides a JSON endpoint to the system which can be used to trigger several operator related actions (resetting charging stations, unlocking connectors etc).
Charging Station Configuration Add-on Configures charging stations that are new to the system and provides a JSON endpoint to create and update charging station configurations.
OCPP/S 1.2 Add-on* Implements OCPP (Open Charge Point Protocol) version 1.2 using SOAP.
OCPP/S 1.5 Add-on* Implements OCPP (Open Charge Point Protocol) version 1.5 using SOAP.
OCPP/J 1.5 Add-on* Implements OCPP (Open Charge Point Protocol) version 1.5 using JSON over Web Sockets.
VAS Add-on* Provides an implementation of the VAS (Value Added Service) interfaces which provides a way to have third parties connect to your Motown instance and display information about the charging stations.
Identification Authorization Add-on Authorizes identifications (eg. RFID tags) by contacting configured authorization services. Motown provides a service that can connect to CIR.
(*)=optional

User Interface

Motown focusses on the backend communication for eMobility Systems, and therefore does not come with a User Interface, user management, or an authentication mechanism. This way you have all the freedom to create a User Interface that meets your needs.

You can connect your User Interface to Motown through the Operator API. The samples folder contains a basic User Interface that connects to the Operator API.

Motown APIs

To integrate your own applications into Motown the Motown APIs can be used.

The following APIs are available:

  • Core API - For connecting your custom Add-Ons with the Motown Core.
  • Configuration API - For adding Charging Station configurations.
  • Operator API - For performing operator tasks, like unlock connector or remote start transaction.

Security

Security within Motown has three levels:

  • Authentication on JSON REST API's
  • Authorization on Motown core
  • Authorization of add-ons (currently not implemented)

Authentication on JSON REST API's

Motown does not come with a default mechanism to enable authentication on JSON REST API's like the Configuration and Operator APIs. The sample-configurations do come with a sample on how this could be implemented using a servlet filter. As these samples are for demonstration purposes only it should be mentioned not to use the authentication code in live environments and should just be used to demonstrate a concept.

Authorization on Motown Core

The Motown Core has a mechanism that checks if a user is allowed to execute the provided command on the charging station. When sending a command into the core, an UserIdentity has to be provided in the IdentityContext.

The Operator API provides a mechanism to grant and revoke user permissions to execute certain commands. For each of the users of your custom built User Interface, you have to grant the required permissions. When using the Operator API it is required to pass a UserIdentity with each call, allowing the Motown Core to check the permission.

Authorization of add-ons

At the moment there is no authorization on Add-On level. Due to the fact that the Add-Ons primarily will be running in a controlled environment, this will not be necessary by default. For future use, each Add-On provides an IdentityContext containing an Add-On identifier.

Maven dependencies

The Motown artifacts are made available on Maven central. To use Motown components check Maven central for the latest available version.

For example, to use the Motown OCPP 1.5 SOAP module version 0.8.2 in a Maven project the following should be in your pom.xml:

<properties>
   <motown.version>0.8.2</motown.version>
   <!-- other properties -->
</properties>

<dependencies>
   <dependency>
      <groupId>io.motown.ocpp</groupId>
      <artifactId>ocpp-v15-soap</artifactId>
      <version>${motown.version}</version>
   </dependency>
   <!-- other dependencies -->
</dependencies>

If you are using Motown in a Grails project, the following example adds a dependency to the operator API module:

compile 'io.motown.operator-api:operator-api-json:0.8.2'

To see other dependency samples please refer to the Maven central website. To see a sample using a complete Motown stack using dependencies please refer to the configuration samples: single app or distributed.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.