Vessel Charging Protocol

The communication protocol for vessel charging describes the format of a request for a charging service (need), and the response sent by a charging provider (bid).

For example, an autonomous boat might search for charging stations within 2 km of the given coordinates that are capable of docking a 1200 kg boat.

In response, a charging station might send back a bid with a price for the service, the opening and closing times, and the full list of services it offers.

Need

A statement of need for charging services. Typically this will be sent by an electric boat that is looking for a charging station around certain coordinates.

This request is sent to the discovery engine which broadcasts the need to DAV identities that can provide this service. Bids are later received in response.

Arguments

const { SDKFactory } = require('dav-js');
const { NeedParams, enums } = require('dav-js/dist/vessel-charging');
const DAV = SDKFactory({
  apiSeedUrls,
  kafkaSeedUrls,
});
const boat = await DAV.getIdentity(boatDavId);

const needParams = new NeedParams({
  location: {
    lat: 32.050382,
    long: 34.766149,
  },
  radius: 20,
  startAt: 1538995253092,
  dimensions: {
    length: 50,
    width: 15,
    height: 20,
  },
  weight: 50000,
  batteryCapacity: 4,
  currentBatteryCharge: 45,
  energySource: enums.EnergySources.Solar,
  amenities: [enums.Amenities.Docking],
});
const need = await boat.publishNeed(needParams);

import { SDKFactory } from 'dav-js';
import { NeedParams, enums } from 'dav-js/dist/vessel-charging';
const DAV = SDKFactory({
  apiSeedUrls,
  kafkaSeedUrls,
});
const boat = await DAV.getIdentity(boatDavId);

const needParams = new NeedParams({
  location: {
    lat: 32.050382,
    long: 34.766149,
  },
  radius: 20,
  startAt: 1538995253092,
  dimensions: {
    length: 50,
    width: 15,
    height: 20,
  },
  weight: 50000,
  batteryCapacity: 4,
  currentBatteryCharge: 45,
  energySource: enums.EnergySources.Solar,
  amenities: [enums.Amenities.Docking],
});
const need = await boat.publishNeed(needParams);

Need filter

Begin listening for incoming needs that match certain requirements. Typically this will be a charging station subscribing to incoming needs from electric boats.

Arguments

const { SDKFactory } = require('dav-js');
const { NeedFilterParams } = require('dav-js/dist/vessel-charging');
const DAV = SDKFactory({
  apiSeedUrls,
  kafkaSeedUrls,
});
const charger = await DAV.getIdentity(chargerDavId);

const needFilterParams = new NeedFilterParams({
  location: {
    lat: 32.050382,
    long: 34.766149,
  },
  radius: 1000,
  maxDimensions: {
    length: 120,
    width: 80,
    height: 100,
  },
});
const needs = await charger.needsForType(needFilterParams);

import { SDKFactory } from 'dav-js';
import { NeedFilterParams } from 'dav-js/dist/vessel-charging';
const DAV = SDKFactory({
  apiSeedUrls,
  kafkaSeedUrls,
});
const charger = await DAV.getIdentity(chargerDavId);

const needFilterParams = new NeedFilterParams({
  location: {
    lat: 32.050382,
    long: 34.766149,
  },
  radius: 1000,
  maxDimensions: {
    length: 120,
    width: 80,
    height: 100,
  },
});
const needs = await charger.needsForType(needFilterParams);

Bid

A bid to provide a charging service. Typically sent from a charger to an electric boat.

Arguments

const { BidParams } = require('dav-js/dist/vessel-charging');

needs.subscribe(need => {
  const bidParams = new BidParams({
    ttl: Date.now() + 3600000,
    price: [
      '15000000000000000000',
      { amount: '1000000000000000000', type: 'flat', description: 'Tax' },
    ],
    entranceLocation: {
      lat: 32.050382,
      long: 34.766149,
    },
    exitLocation: {
      lat: 32.050382,
      long: 34.766149,
    },
    locationName: 'Marine Programs Naval Science'
    locationNameLang: 'eng'
    locationCity: 'Vallejo',
    locationPostalCode: '94590',
    locationCounty: 'Solano',
    locationState: 'CA',
    locationCountry: 'USA',
    availableFrom: Date.now(),
    availableUntil: Date.now() + 3600000,
    energySource: EnergySources.Hydro,
    amenities: [Amenities.Park],
    provider: 'HoldenCharge',
    manufacturer: 'Holden Tech LLC',
    model: 'MegaBolt',
  });
  const bid = await need.createBid(bidParams);
});

import { BidParams } from 'dav-js/dist/vessel-charging';

needs.subscribe((need: Need<NeedParams>) => {
  const bidParams = new BidParams({
    ttl: Date.now() + 3600000,
    price: [
      '15000000000000000000',
      { amount: '1000000000000000000', type: 'flat', description: 'Tax' },
    ],
    entranceLocation: {
      lat: 32.050382,
      long: 34.766149,
    },
    exitLocation: {
      lat: 32.050382,
      long: 34.766149,
    },
    locationName: 'Marine Programs Naval Science'
    locationNameLang: 'eng'
    locationCity: 'Vallejo',
    locationPostalCode: '94590',
    locationCounty: 'Solano',
    locationState: 'CA',
    locationCountry: 'USA',
    availableFrom: Date.now(),
    availableUntil: Date.now() + 3600000,
    energySource: EnergySources.Hydro,
    amenities: [Amenities.Park],
    provider: 'HoldenCharge',
    manufacturer: 'Holden Tech LLC',
    model: 'MegaBolt',
  });
  const bid = await need.createBid(bidParams);
});

Starting

A message sent by the service provider (the charger) to the service requester, notifying it that the mission has started

Arguments

const { StartingMessageParams } = require('dav-js/dist/vessel-charging');

const startingMessage = new StartingMessageParams();
mission.sendMessage(startingMessage);

import { StartingMessageParams } from 'dav-js/dist/vessel-charging';

const startingMessageParams = new StartingMessageParams();
mission.sendMessage(startingMessage);

Request Status

A request message sent by either party, asking the other party for a status update

Arguments

const { StatusRequestMessageParams } = require('dav-js/dist/vessel-charging');

const statusRequestMessage = new StatusRequestMessageParams({});
mission.sendMessage(statusRequestMessage);

import { StatusRequestMessageParams } from 'dav-js/dist/vessel-charging';

const statusRequestMessage = new StatusRequestMessageParams({});
mission.sendMessage(statusRequestMessage);

Provider Status

A status update sent by the service provider (usually a charging station) to the vessel

Arguments

const { ProviderStatusMessageParams } = require('dav-js/dist/vessel-charging');

const providerStatusMessage = new ProviderStatusMessageParams({
  chargeCompletionEstimatedTime: Date.now() + 5000,
});
mission.sendMessage(providerStatusMessage);

import { ProviderStatusMessageParams } from 'dav-js/dist/vessel-charging';

const providerStatusMessage = new ProviderStatusMessageParams({
  chargeCompletionEstimatedTime: Date.now() + 5000,
});
mission.sendMessage(providerStatusMessage);

Vessel Status

A status update sent by the service requester (the vessel) to the service provider (charger)

Arguments

const { VesselStatusMessageParams } = require('dav-js/dist/vessel-charging');

const vesselStatusMessage = new VesselStatusMessageParams({
  location: {
    lat: 32.050382,
    long: 34.766149,
  },
});
mission.sendMessage(vesselStatusMessage);

import { VesselStatusMessageParams } from 'dav-js/dist/vessel-charging';

const vesselStatusMessage = new VesselStatusMessageParams({
  location: {
    lat: 32.050382,
    long: 34.766149,
  },
});
mission.sendMessage(vesselStatusMessage);

Charging Arrival

A message sent by the service requester (the vessel) to the service provider (charger), notifying it that it has arrived at the charger's location

Arguments

const { ChargingArrivalMessageParams } = require('dav-js/dist/vessel-charging');

const chargingArrivalMessage = new ChargingArrivalMessageParams();
mission.sendMessage(chargingArrivalMessage);

import { ChargingArrivalMessageParams } from 'dav-js/dist/vessel-charging';

const chargingArrivalMessage = new ChargingArrivalMessageParams();
mission.sendMessage(chargingArrivalMessage);

Charging Started

A message sent by the service provider to the service requester, notifying it that charging has begun

Arguments

import { ChargingStartedMessageParams } from 'dav-js/dist/vessel-charging';

const chargingStartedMessage = new ChargingStartedMessageParams();
mission.sendMessage(chargingStartedMessage);

const { ChargingStartedMessageParams } = require('dav-js/dist/vessel-charging');

const chargingStartedMessage = new ChargingStartedMessageParams();
mission.sendMessage(chargingStartedMessage);

Charging Complete

A message sent by the service provider to the service requester, notifying it that charging has completed

Arguments

const {
  ChargingCompleteMessageParams,
} = require('dav-js/dist/vessel-charging');

const chargingCompleteMessage = new ChargingCompleteMessageParams();
mission.sendMessage(chargingCompleteMessage);

import { ChargingCompleteMessageParams } from 'dav-js/dist/vessel-charging';

const chargingCompleteMessage = new ChargingCompleteMessageParams();
mission.sendMessage(chargingCompleteMessage);

Energy Sources

The energy source used by the charger.

Amenities

A list of amenities can be included in both requests and responses.

Price Types

Price types and their unique identifier.