A Node-RED integration for the Longship charging station management platform. This collection of nodes enables interaction with OCPP-compliant charging stations through the Longship API.
npm install @gaia-charge/node-red-contrib-longshipBefore using any of the command nodes, you need to configure the Longship connection details:
- Add a "longship-config" node to your flow
- Configure:
- Base URL (default: https://api.longship.io)
- Tenant Key (
Ocp-Apim-Subscription-Key) - Application Key (
x-api-key)
- longship-config: Stores connection details for the Longship API including base URL and authentication keys.
-
Clear Cache
- Clears the internal cache of a charging point
- Input: chargePointId
-
Reset
- Resets a charging point (soft or hard reset)
- Input: chargePointId, type (Soft/Hard)
-
Trigger Message
- Requests specific messages from a charging point
- Supported messages: BootNotification, Heartbeat, StatusNotification, MeterValues
- Input: chargePointId, requestedMessage, connectorId
-
Remote Start
- Initiates a charging session
- Input: chargePointId, connectorId, idTag (optional)
-
Remote Stop
- Stops an active charging session
- Input: chargePointId, transactionId
-
Clear Charging Profile
- Removes charging profiles from a charging point
- Input: chargePointId, various profile filters
-
Get Composite Schedule
- Retrieves the composite charging schedule
- Input: chargePointId, connectorId, duration, chargingRateUnit
-
Set Charging Profile
- Configures charging profiles
- Input: chargePointId and profile configuration
-
Data Transfer
- Sends custom data to charging points
- Input: chargePointId and transfer data
-
Unlock Connector
- Unlocks a connector on a charging point
- Input: chargePointId, connectorId
-
Update Firmware
- Initiates firmware updates on charging points
- Input: chargePointId and firmware details
Here's a basic example of how to trigger a status notification:
- Add a
longship-confignode and configure your credentials - Add a
trigger-messagenode and configure:- Server: Select your config node
- Message Type: StatusNotification
- Connector ID: 1
- Inject a message with:
{ "chargePointId": "CP001" }
All nodes provide error feedback through:
- Node status indicators
- Error messages in the Node-RED debug panel
- Error outputs in the message payload
MIT License