example

ocpp1.6-go

Open Charge Point Protocol (OCPP) version 1.6 in Go.

Example

Example shows implementation ocppj version 1.6 for central system.

Folder structure

• callbacks.go - Includes handlers for each OCPP request (Implementation DB logic)
• configs.json - File to specify list of chargers for the demo in JSON format
• simplequeue.go - Simple messages queue and charger objects for the demo only
• api.go - Handlers for the client API requests
• README.md - this file

Docker

To spin contaienr on docker, please use commands below:

docker build -t ocpp16:latest -f Dockerfile .
docker run --rm --name ocpp16-example -p "9033:8080" ocpp16:latest

Endpoint for the chargers

ws://localhost:9033/ocppj/1.6/{chargerName}

Central System Example

To use library in your project, you must implement the callbacks with your business logic, as shown below:

import (
	"time"
	"net/http"
	"github.com/CoderSergiy/golib/logging"
	"github.com/CoderSergiy/ocpp16-go/core"
	"github.com/CoderSergiy/ocpp16-go/messages"
)

type OCPPHandlers struct {
    // ... Add required variables for your implementation
}

func (cs *OCPPHandlers) BootNotificationRequestHandler (callMessage messages.CallMessage) (string, error, bool) {

    // ... Implement your business logic

	// Create CallResult message
	callMessageResponse := messages.CallResultMessageWithParam (
		callMessage.UniqueID,
		bootNotificationResp.GetPayload(),
	)

	return callMessageResponse.ToString(), nil, WEBSOCKET_KEEP_OPEN
}

// further callbacks... 

Requirements for the design

Name of the methods for the call requests has to in in the format: action + "RequestHandler", as example "HeartbeatRequestHandler".

For the responses handlers have to be in the formar: action + "ResponseHandler", as example "AuthorizeResponseHandler".

The error handler named "OCPPErrorHandler".

API to work with server

Get status of the charger

Charger needs to be add to the connfigs.json Example:

curl --request GET 'http://localhost:9033/charger/{chargerName}/status'

Get status of the message

All messages are using unique ID. Please, use it to inquire status from the server Example:

curl --request GET 'http://localhost:9033/message/{messageUniqueID}/status'

Initiate the TriggerAction by server (from CS to CP)

API to inject message for the charger, to make possible for Central System trigger Charge Point-initiated message. In response for successful created message server will returns 'uniqueid' which you can use to obtain status using Get Message Satatus API. Example:

curl --request POST 'http://localhost:9033/command/{chargerName}/triggeraction/{action}'

Permitted values for the 'action' parameter, regarding OCPP document you can find in the list below:

• BootNotification
• DiagnosticsStatusNotification
• FirmwareStatusNotification
• Heartbeat
• MeterValues
• StatusNotification