@teslemetry/node-red-contrib-teslemetry 0.12.0
Node-RED nodes for controlling Tesla vehicles and energy sites via Teslemetry API
Node-RED Teslemetry Integration
Node-RED nodes for controlling Tesla vehicles and energy sites via the Teslemetry API.
Features
- 🚗 Vehicle Control: Lock/unlock, climate, charging, navigation, and more
- âš¡ Energy Management: Monitor and control Powerwall and Solar systems
- 📡 Real-Time Events: React to vehicle state changes via Server-Sent Events
- 🎯 Signal Monitoring: Track specific vehicle data fields (speed, battery, etc.)
- 🔄 Full API Coverage: Access all Teslemetry API features
Installation
From npm (Recommended)
Navigate to your Node-RED user directory (usually ~/.node-red) and install:
cd ~/.node-red
npm install @teslemetry/node-red-contrib-teslemetry
Then restart Node-RED.
From Node-RED Palette Manager
- Open Node-RED in your browser
- Go to Menu → Manage palette
- Click the Install tab
- Search for
@teslemetry/node-red-contrib-teslemetry - Click Install
Local Development
cd ~/.node-red
npm install /path/to/packages/node-red-contrib-teslemetry
Prerequisites
- Teslemetry Account: Sign up at teslemetry.com
- Access Token: Generate an API access token from your Teslemetry dashboard
- Tesla Virtual Key: Configure virtual key access for your vehicle(s)
Configuration
- Drag a Teslemetry node onto your flow
- Double-click to edit and add a new Teslemetry Config
- Enter your Teslemetry access token
- Save and deploy
Nodes
teslemetry-config
Configuration node to store your Teslemetry Access Token.
Configuration:
- Access Token: Your Teslemetry access token.
- Replay last known values on connect: Off by default, so nodes stay silent until a value next changes. When ticked, Teslemetry sends its last known state each time the stream connects or reconnects. Replayed events carry
isCache: truein the payload of the event nodes; a Signal node outputs only the value, so a replayed value there has no marker.
teslemetry-local-powerwall
Configuration node that connects Node-RED to a Powerwall gateway on your local network. Node-RED must be on the same network as the gateway. Pick it in the Local gateway field of an Energy Command node to send commands to the Powerwall without the internet, or of a Local Powerwall Read node to read the gateway.
Configuration:
- Config: Select your Teslemetry Config node
- Energy site: The site whose Powerwall to connect to
- Pair: Creates Node-RED's own key and registers it with the Powerwall through Teslemetry. Flick the On/Off switch on your primary Powerwall off and back on to approve it (only needed once), then press Pair again
- Address: The gateway's address on your network, filled in from Teslemetry. Give the gateway a fixed address on your router
- Password: The gateway's Wi-Fi password, from the QR label behind the front cover of a Powerwall 3 or behind the Backup Gateway door on a Powerwall 2
- Verify: Logs in to the gateway and sends one signed request, to check the password and the key
- Remove key: Removes Node-RED's key from the gateway. Deleting the config node does not remove it
The key and password are stored as Node-RED credentials: outside your flows, never in an exported flow, and not shown again in the editor. Set credentialSecret in settings.js to encrypt them with a secret of your own.
teslemetry-local-powerwall-read
Reads a Powerwall gateway over your local network, with no internet or Teslemetry in between. It polls the gateway itself and sends what the gateway returns as it is. The cloud nodes (Energy Event, Energy Command) are unchanged; this node does not merge local data into them.
Configuration:
- Local gateway: A Teslemetry Local Powerwall config node, paired and verified.
- Read: What to read:
- Live status: solar, battery, home and grid power, the battery level and the grid status, in the shape of the cloud's
live_status. Values the gateway has no source for arenull. - Meters (aggregates): the gateway's
/api/meters/aggregates, power, energy and voltage per meter (site,battery,load,solar...). - System status and Device controller: the gateway's status queries (battery energy, grid connection, meter power, alerts; the second adds more device detail).
- Grid status: a string such as
SystemGridConnected. - State of energy: the battery level as the Tesla app shows it, and State of energy (raw) as the gateway counts it, which includes a 5% buffer.
- Gateway config (
config.json), Components (Powerwall 3), Firmware and Backup events.
- Live status: solar, battery, home and grid power, the battery level and the grid status, in the shape of the cloud's
- Poll every: Seconds between reads, 10 by default, from 2 to 86400 (24 hours). Set 0 to read only when a message arrives.
Any input message also reads the gateway once. Polling stops when the flow is redeployed or stopped.
Outputs:
msg.payload: What the gateway returned for the read (an object, or a string or number for grid status and state of energy).msg.topic: The read's name, such asmeters_aggregates.
The node status shows the time of the last read, or the error. A read triggered by a message that fails goes to a catch node; a gateway that stays unreachable while polling is logged once, not on every poll.
teslemetry-vehicle-command
Send commands to a specific vehicle or retrieve vehicle data.
Configuration:
- VIN: Select a vehicle or leave empty to use
msg.vin. - Command: Select a command, or choose From msg.command to take it from each message. The list holds every vehicle command in the Teslemetry API, grouped as the API groups them, with its credit cost. Commands only some models take, such as Cybertruck outlets, are listed only for that model. A node saved with an earlier command name keeps it, under Earlier names (still supported).
- Fields: Each argument of the selected command, as a fixed value or read from
msg,flow,global, an environment variable or JSONata. By default each readsmsg.payload.<field>. Allowed values are a dropdown, and the field shows its range and whether it is required.
A VIN or command selected in the node always wins; msg.vin and msg.command are only read when the matching dropdown is set to its From msg… option. Command arguments are read from the top level of the message (msg.percent, not msg.payload.percent).
msg.command also takes any vehicle command from the Teslemetry API by its route name, such as set_charge_limit, closure or charge_on_solar. These read their arguments from msg.payload using the API's field names (a field set in the node wins over msg.payload), for example msg.payload = { "percent": 80 }, and check them against the API's ranges and allowed values before sending. A command that reads state, such as managed_charging_sites, takes no arguments, and get_charge_on_solar reads what charge_on_solar sets.
Inputs:
msg.vin(string): VIN of the vehicle (when VIN is From msg.vin).msg.command(string): Command to execute, e.g.lockDoors(when Command is From msg.command).msg.driver_temp(number): Driver temperature forsetTemps.msg.passenger_temp(number): Passenger temperature forsetTemps.msg.seat(string): Seat position forsetSeatHeater(e.g.,front_left).msg.level(number): Heat level (0-3) forsetSeatHeater.msg.percent(number): Charge limit percentage forsetChargeLimit.msg.amps(number): Charging amps forsetChargingAmps.msg.lat(number): Latitude fortriggerHomelink.msg.lon(number): Longitude fortriggerHomelink.msg.value(string): Address or text fornavigationRequest.
Outputs:
msg.payload: The response from the API, e.g.{ "result": true, "reason": "" }.
When the vehicle refuses a command (result: false), the node raises an error naming the reason (e.g. Command refused: could_not_wake_buses) that a catch node receives with the original message, shows it in a red status, and sends nothing on its output. Refusals meaning the vehicle is already in the requested state - already_set, not_charging and requested - are not errors: the message is sent on as normal with msg.payload.result still false.
teslemetry-energy-command
Send commands to a Tesla Energy Site or retrieve site status.
Configuration:
- Site ID: Select a site or leave empty to use
msg.siteId. - Route: Automatic (the default, and how nodes saved before this setting behave) sends to the Local gateway first and to the cloud only when the gateway gives no answer. Local only never uses the cloud: only commands the gateway takes are offered, and an unreachable gateway is an error. Cloud only never uses your local network; commands that need a key the gateway trusts then need the site paired with Teslemetry. The node label shows a Local only or Cloud only route.
- Local gateway: Optional (hidden for Cloud only). A Teslemetry Local Powerwall config node. Backup reserve, operation mode, grid export, dispatch, resume, go off-grid and reconnect to grid then go to the gateway over your local network first, and through the cloud only if the gateway does not answer. The node status shows
localorcloud. - Command: Select a command, or choose From msg.command to take it from each message. The list holds every energy site command in the Teslemetry API, grouped as the API groups them. Commands that need a key the gateway trusts (dispatch, backup events, island mode, gateway config and diagnostics) are greyed out for a site that is not paired with Teslemetry, except dispatch, resume and island mode when this node has a Local gateway for the site, which signs those itself. A node saved with an earlier command name keeps it, under Earlier names (still supported).
- Fields: Each argument of the selected command, as a fixed value or read from
msg,flow,global, an environment variable or JSONata. By default each readsmsg.payload.<field>.
A site or command selected in the node always wins; msg.siteId and msg.command are only read when the matching dropdown is set to its From msg… option. Earlier command names (setBackupReserve, ...) read their arguments from the top level of the message, not from msg.payload.
msg.command also takes any energy site command from the Teslemetry API by its route name, such as backup, storm_mode or schedule_backup_event. These read their arguments from msg.payload using the API's field names (a field set in the node wins over msg.payload), for example msg.payload = { "backup_reserve_percent": 40 }. With a Local gateway, backup, operation, grid_import_export, dispatch_battery_power, resume_battery_operation and set_island_mode go to the gateway first, as the earlier names do.
Inputs:
msg.siteId(number): Energy Site ID (when Site ID is From msg.siteId).msg.command(string): Command to execute, e.g.setStormModeOn(when Command is From msg.command).msg.percentage(number): Backup reserve percentage forsetBackupReserve.msg.percent(number): Off-grid reserve percentage forsetOffGridVehicleChargingReserve.msg.tariffContentV2(object): Full time-of-use tariff document forsetTimeOfUseSettings, matching theTariffContentV2shape (version,utility,code,name,currency,daily_charges,demand_charges,energy_charges,seasonsrequired). Replaces the site's entire time-of-use schedule - it is not merged with the existing schedule.msg.powerWatts(number) andmsg.durationSeconds(number): FordispatchBatteryPower, the battery power in watts from -100000 to 100000 (positive discharges, negative charges) and how long to hold it, 1 to 86400 whole seconds.
teslemetry-energy-history
Retrieve historical data for a Tesla Energy Site.
Configuration:
- Site ID: Select a site, or choose From msg.siteId.
- History Type: Energy History (solar, battery and grid energy), Backup History (off-grid events) or Telemetry (Charging) (Wall Connector charging history), or choose From msg.historyType.
- Period: Day, Week, Month or Year, or choose From msg.period. Not used for Telemetry (Charging).
- Start Date / End Date / Time Zone: Leave empty to use
msg.startDate/msg.endDate/msg.timeZone.
A value set in the node always wins; the matching message property is only read when the node's own value is empty or From msg….
Inputs:
msg.siteId(number): Energy Site ID.msg.historyType(string):energy,backuportelemetry(defaults toenergy).msg.period(string):day,week,monthoryear(defaults today).msg.startDate/msg.endDate(string): Date-time with a UTC offset, e.g.2026-01-15T00:00:00-08:00.msg.timeZone(string): IANA time zone, e.g.America/Los_Angeles.
Outputs:
msg.payload: The history response from the API.
teslemetry-energy-event
Listen for real-time Server-Sent Events (SSE) from one Tesla Energy Site.
Configuration:
- Site ID: The site to listen to (required - this node cannot listen across all sites).
- Event Type: The type of event to listen for.
Event Types:
- all: Every event type below
- live_status: Live power flow (solar, battery, grid, load, Wall Connectors)
- site_info: Site configuration changes
- tariff_content_v2: Time-of-use tariff changes;
nullmeans the tariff was removed - energy_totals: Daily energy totals
Outputs:
msg.payload: The whole event object. Its data sits under a key named after the event type - e.g.msg.payload.live_status.solar_power- exceptenergy_totals, which carriesdateandtotalsat the top level.msg.topic: The event type that firedmsg.siteId: The Energy Site ID the event belongs to
teslemetry-event
Listen for real-time Server-Sent Events (SSE) from Teslemetry.
Configuration:
- VIN: Filter events for a specific vehicle (optional).
- Event Type: The type of event to listen for.
Event Types:
- all: Stream all events
- data: Real-time telemetry data updates
- state: State changes (online/asleep/charging)
- vehicle_data: Full vehicle data snapshots
- errors: Vehicle error events
- alerts: Vehicle alerts and notifications
- connectivity: Connection status changes
- credits: API credit usage updates
- config: Configuration changes
Outputs:
msg.payload: The event data objectmsg.topic: The event type
teslemetry-signal
Listen for specific signal changes from a vehicle.
Configuration:
- VIN: The vehicle to monitor
- Field: The specific signal field to listen for (e.g.,
VehicleSpeed,Odometer,BatteryLevel). Both are chosen in the node - it has no input, so neither can come from a message.
Outputs:
msg.payload: The new value of the signalmsg.topic:signalmsg.field: The name of the field
Signal fields use the streaming names shown in the dropdown, which differ from the vehicle_data names returned by Get Vehicle Data (BatteryLevel there is charge_state.battery_level).
Units and null values
Values are passed through exactly as the vehicle or site reports them; nothing is converted to your locale.
- Vehicle distances are in miles and speeds in mph regardless of the car's display setting -
Odometeris miles,VehicleSpeedis mph.BatteryLevelis a percentage (0-100). - Energy site values are likewise the raw numbers Tesla reports.
- Any signal value can be
nullwhen the vehicle has no reading for that field. Check for it before comparing: in JavaScriptnull < 20istrue.
teslemetry-wall-connector
Splits an Energy Site's wall_connectors array (e.g. from a teslemetry-energy-event live_status message) into one message per connector.
Configuration:
- DIN Filter: Only emit the connector matching this DIN, or leave empty to emit all (optional; can also come from
msg.din).
Inputs:
msg.payload(object | array): Ateslemetry-energy-eventlive_statusmessage (array atpayload.live_status.wall_connectors), alive_status-shaped object with awall_connectorsarray, or that array directly.msg.din(string, optional): Restrict output to one DIN for this message.
Outputs (one per matching connector):
msg.payload: The connector's raw objectmsg.topic: The connector's DINmsg.din: The connector's DIN
A DIN absent from the input emits nothing for that DIN - it does not send a synthetic "offline" event.
Usage Examples
Example 1: Lock Vehicle When Leaving Home
- Add a geofence or location trigger node
- Add a function node to set
msg.command = "lockDoors" - Add a teslemetry-vehicle-command node with your VIN configured and Command set to From msg.command
- Connect them together
Example 2: Start Climate Control on Schedule
- Add an inject node configured for your departure time
- Add a teslemetry-vehicle-command node
- Set Command to Start HVAC
- Set temperatures using setTemps with
msg.driver_tempandmsg.passenger_temp
Example 3: Monitor Charging and Send Notifications
- Add a teslemetry-event node
- Set Event Type to data
- Add a function node to filter charging-related updates
- Add an email or pushover node for notifications
- Send alert when charging completes
Example 4: Alert on Low Battery
- Add a teslemetry-signal node
- Set Field to
BatteryLevel - Add a switch node to check if value is not
nulland < 20 - Add notification node (email/SMS/Pushover)
Example 5: Charge on Solar
Import Charge on Solar from Import > Examples in the Node-RED menu. It turns charging on solar on with 50-80% limits or off (charge_on_solar), reads the current setting (get_charge_on_solar) and lists the Powerwall sites the vehicle charges on solar at (managed_charging_sites). The vehicle must already be linked to the Powerwall in the Tesla app.
Available Vehicle Commands
- Get Vehicle Data: Retrieves comprehensive vehicle information
- Wake Up: Wakes up the vehicle from sleep
- Flash Lights: Flashes the headlights
- Honk Horn: Honks the horn
- Lock/Unlock Doors: Controls door locks
- Remote Start: Enables keyless driving
- Actuate Trunk: Opens the front trunk; toggles the rear trunk (a powered rear trunk that is open closes)
- Tonneau: Opens/closes the tonneau cover (Cybertruck)
- Sunroof: Vent/close/stop (legacy Model S/X with a panoramic sunroof)
- Climate Control: Start/stop HVAC, set temps, seat heaters, steering wheel heater, cabin overheat protection, auto seat/steering-wheel climate
- Charging: Start/stop, open/close port, set limit, set amps, scheduled charging/departure
- Charge/Precondition Schedules: Add/update or remove location-based charge and precondition schedules
- Sentry Mode: Enable/disable Sentry Mode
- Homelink: Trigger Homelink at specific coordinates
- Navigation: Send destination to vehicle navigation
- Media: Set absolute volume (compose relative up/down from the
MediaAudioVolume/MediaAudioVolumeIncrementsignals in a function node) - Software Update: Schedule (or install now) or cancel a pending update
- Guest Mode: Enable/disable Guest Mode
- Valet Mode: Enable/disable (requires
msg.password), plus reset a forgotten valet PIN - PIN to Drive: Enable/disable (requires
msg.password), plus admin-clear or reset a lost PIN - Speed Limit Mode: Activate/deactivate/clear PIN (requires
msg.pin), admin-clear a lost PIN, or set the limit in mph
Available Energy Commands
- Get Live Status: Live power usage details
- Get Site Info: Configuration and site details
- Set Backup Reserve: Set battery reserve percentage
- Set Operation Mode: Self Consumption, Backup, or Autonomous
- Set Storm Mode: Enable/disable Storm Mode
- Grid Import/Export: Configure grid export rules (Everything, Solar Only, Nothing)
- Off-Grid Reserve: Set vehicle charging reserve for off-grid operation
- Dispatch Battery Power: Charge or discharge the battery at a set power for a set time, after which it returns to normal operation by itself. A new dispatch replaces the previous one, and a dispatch can discharge below the backup reserve and export regardless of the export setting.
- Resume Battery Operation: End a dispatch early
- Go Off-Grid: Disconnect the home from the grid. The whole home then runs from the battery (and solar) until you send Reconnect to Grid. The gateway can refuse, for example when the battery is low. Check
island_statusfrom Get Live Status afterwards. - Reconnect to Grid: Reconnect the home to the grid
Dispatch, resume, off-grid and reconnect need a local gateway set on the node, or the site paired with Teslemetry (Teslemetry's key verified on the gateway from the Teslemetry console). They are greyed out in the editor for a site that is not paired, and the node refuses them at runtime for one.
Earlier command names
Nodes and flows that use an earlier command name keep working unchanged, with their arguments at the top level of the message. The API route name runs the same command, with its arguments in msg.payload under the API's field names. The editor lists the API route names; an earlier name stays selected in a node saved with it.
Vehicle Command
| Earlier name | API route name | msg.payload fields |
|---|---|---|
vehicleData |
- | Not a command route; stays as is |
wakeUp |
- | Not a command route; stays as is |
flashLights |
flash_lights |
|
honkHorn |
honk_horn |
|
lockDoors |
door_lock |
|
unlockDoors |
door_unlock |
|
actuateTrunkRear / actuateTrunkFront |
actuate_trunk |
which_trunk: rear / front |
tonneauOpen / tonneauClose |
closure |
tonneau: open / close |
sunRoofVent / sunRoofClose / sunRoofStop |
sun_roof_control |
state: vent / close / stop |
startAutoConditioning / stopAutoConditioning |
auto_conditioning_start / auto_conditioning_stop |
|
setCabinOverheatProtectionOn / Off / FanOnly |
set_cabin_overheat_protection |
on, fan_only |
setCopTemp |
set_cop_temp |
cop_temp (was msg.level) |
setTemps |
set_temps |
driver_temp, passenger_temp |
setSeatHeater |
remote_seat_heater_request |
heater (a seat number 0-8, was a seat name in msg.seat), level |
setSeatCooler |
remote_seat_cooler_request |
seat_position (a seat number 1-2, was a seat name in msg.seat), seat_cooler_level (was msg.level) |
setAutoSeatClimate |
remote_auto_seat_climate_request |
auto_seat_position (a seat number, was a seat name in msg.seat), auto_climate_on (was msg.on) |
setSteeringWheelHeaterOn / Off |
remote_steering_wheel_heater_request |
on |
setAutoSteeringWheelHeatOn / Off |
remote_auto_steering_wheel_heat_climate_request |
on |
setPreconditioningMaxOn / Off |
set_preconditioning_max |
on, manual_override |
setClimateKeeperMode |
set_climate_keeper_mode |
climate_keeper_mode (was msg.mode) |
setBioweaponDefenseModeOn / Off |
set_bioweapon_mode |
on, manual_override |
startCharging / stopCharging |
charge_start / charge_stop |
|
openChargePort / closeChargePort |
charge_port_door_open / charge_port_door_close |
|
setChargeLimit |
set_charge_limit |
percent |
setChargingAmps |
set_charging_amps |
charging_amps (was msg.amps) |
setScheduledCharging |
set_scheduled_charging |
enable, time in minutes after midnight (was HH:mm) |
setScheduledDeparture |
set_scheduled_departure |
API field names; times in minutes after midnight (were HH:mm) |
addChargeSchedule / addPreconditionSchedule |
add_charge_schedule / add_precondition_schedule |
API field names; times in minutes after midnight (were HH:mm) |
removeChargeSchedule / removePreconditionSchedule |
remove_charge_schedule / remove_precondition_schedule |
id |
setSentryModeOn / Off |
set_sentry_mode |
on |
remoteStart |
remote_start_drive |
|
triggerHomelink |
trigger_homelink |
lat, lon |
scheduleSoftwareUpdate / cancelSoftwareUpdate |
schedule_software_update / cancel_software_update |
offset_sec (was msg.offsetSec) |
navigationRequest |
navigation_request |
value, locale, type, timestamp_ms |
navigationGpsRequest |
navigation_gps_request |
lat, lon, order |
navigationSuperchargerRequest |
navigation_sc_request |
id, order |
navigationWaypointsRequest |
navigation_waypoints_request |
waypoints |
adjustVolume |
adjust_volume |
volume |
mediaTogglePlayback / mediaNextTrack / mediaPreviousTrack |
media_toggle_playback / media_next_track / media_prev_track |
|
setGuestModeOn / Off |
guest_mode |
enable |
setValetModeOn / Off |
set_valet_mode |
on, password |
resetValetPin |
reset_valet_pin |
|
setPinToDriveOn / Off |
set_pin_to_drive |
on, password |
clearPinToDrive / clearPinToDriveAdmin / resetPinToDrive |
clear_pin_to_drive / clear_pin_to_drive_admin / reset_pin_to_drive_pin |
pin for clear_pin_to_drive |
speedLimitActivate / Deactivate / ClearPin |
speed_limit_activate / speed_limit_deactivate / speed_limit_clear_pin |
pin |
speedLimitClearPinAdmin |
speed_limit_clear_pin_admin |
|
speedLimitSetLimit |
speed_limit_set_limit |
limit_mph (was msg.limitMph) |
Energy Command
| Earlier name | API route name | msg.payload fields |
|---|---|---|
getLiveStatus / getSiteInfo |
live_status / site_info |
|
getTariff |
- | Not a command route; stays as is |
setBackupReserve |
backup |
backup_reserve_percent (was msg.percentage) |
setOperationModeSelfConsumption / Backup / Autonomous |
operation |
default_real_mode: self_consumption / backup / autonomous |
setStormModeOn / Off |
storm_mode |
enabled |
gridExportEverything / Solar / Nothing |
grid_import_export |
customer_preferred_export_rule: battery_ok / pv_only / never |
setOffGridVehicleChargingReserve |
off_grid_vehicle_charging_reserve |
off_grid_vehicle_charging_reserve_percent (was msg.percent) |
setTimeOfUseSettings |
time_of_use_settings |
tou_settings: { tariff_content_v2 } (was msg.tariffContentV2) |
dispatchBatteryPower |
dispatch_battery_power |
power_watts, duration_seconds |
resumeBatteryOperation |
resume_battery_operation |
|
goOffGrid / reconnectGrid |
set_island_mode |
mode: 6 with force: true / 1 |
Resources
- Teslemetry Documentation: https://teslemetry.com/docs
- API Reference: https://developer.teslemetry.com
- Support: https://github.com/Teslemetry/typescript-teslemetry/issues
License
Apache-2.0 License - see LICENSE file for details
Contributing
Contributions are welcome! Please see the main repository for contribution guidelines.