leafpy

Lightweight python interface to the nissan leaf. Check battery status, turn on the AC, start charging, etc.

Installation

pip install leafpy

Examples:

Login:

You need to add the region_code if you're not from US.

• COUNTRY_CANADA = 'NCI'
• COUNTRY_US = 'NNA'
• COUNTRY_EU = 'NE'
• COUNTRY_AUSTRALIA = 'NMA'
• COUNTRY_JAPAN = 'NML'

from leafpy import Leaf
leaf = Leaf('<your-username>', '<your-password>', region_code = 'NE')

Or with custom_sessionid & VIN:

from leafpy import Leaf
leaf = Leaf(custom_sesionid='<your-custom_sessionid>', VIN='<your-VIN>')
# you can get these values from a previous login:
# leaf.VIN, leaf.custom_sessionid

Check Battery Status:

leaf.BatteryStatusRecordsRequest()

results in:

{
    "status": 200,
    "BatteryStatusRecords": {
        "BatteryStatus": {
            "BatteryRemainingAmountkWH": "",
            "SOC": {
                "Value": "100"
            },
            "BatteryChargingStatus": "NOT_CHARGING",
            "BatteryRemainingAmount": "240",
            "BatteryCapacity": "240",
            "BatteryRemainingAmountWH": "28880"
        },
        "OperationResult": "START",
        "NotificationDateAndTime": "2017/04/24 23:43",
        "CruisingRangeAcOff": "198000",
        "OperationDateAndTime": "2017/04/24 23:43",
        "CruisingRangeAcOn": "192000",
        "PluginState": "CONNECTED",
        "TargetDate": "2017/04/24 23:43"
    },
    "VoltLabel": {
        "HighVolt": "240",
        "LowVolt": "120"
    }
}

Query for Battery Status:

response = leaf.BatteryStatusCheckRequest()
# Wait a few seconds for the request to be made to the car
leaf.BatteryStatusCheckResultRequest(resultKey=response['resultKey'])

results in:

{
    "status": 200,
    "currentChargeLevel": "0",
    "timeRequiredToFull": {
        "hours": "",
        "minutes": ""
    },
    "timeRequiredToFull200_6kW": {
        "hours": "",
        "minutes": ""
    },
    "operationResult": "START",
    "timeStamp": "2017-04-25 05:23:48",
    "pluginState": "CONNECTED",
    "cruisingRangeAcOff": "198000.0",
    "timeRequiredToFull200": {
        "hours": "",
        "minutes": ""
    },
    "batteryCapacity": "240",
    "cruisingRangeAcOn": "192000.0",
    "responseFlag": "1",
    "batteryDegradation": "240",
    "charging": "NO",
    "chargeStatus": "CT",
    "chargeMode": "NOT_CHARGING"
}

Turn on Climate Control:

response = leaf.ACRemoteRequest()
# Wait a few seconds for the request to be made to the car
# Check status if you don't want to assume it worked:
leaf.ACRemoteResult(resultKey=response['resultKey'])

results in:

{
    "status": 200,
    "hvacStatus": "ON",
    "operationResult": "START",
    "timeStamp": "2017-04-25 05:38:09",
    "acContinueTime": "7200",
    "responseFlag": "1"
}

Turn off Climate Control:

response = leaf.ACRemoteOffRequest()
# Wait a few seconds for the request to be made to the car
# Check status if you don't want to assume it worked:
leaf.ACRemoteOffResult(resultKey=response['resultKey'])

results in:

{
    "status": 200,
    "timeStamp": "2017-04-25 05:40:27",
    "hvacStatus": "OFF",
    "operationResult": "START",
    "responseFlag": "1"
}

Get latest climate control status:

leaf.RemoteACRecordsRequest()

results in:

{
    "status": 200,
    "RemoteACRecords": {
        "ACDurationPluggedSec": "7200",
        "ACStartStopDateAndTime": "2017/04/25 05:40",
        "ACStartStopURL": "",
        "PreAC_temp": "75",
        "OperationResult": "START",
        "PreAC_unit": "F",
        "OperationDateAndTime": "2017/04/25 05:40",
        "PluginState": "CONNECTED",
        "ACDurationBatterySec": "900",
        "RemoteACOperation": "STOP"
    }
}

Get Car Location:

Apparently Deprecated

Start Charging:

leaf.BatteryRemoteChargingRequest()

Schedule Climate Control:

leaf.ACRemoteNewRequest(ExecuteTime='2016-02-09 17:24')

Update Scheduled Climate Control:

leaf.ACRemoteUpdateRequest(ExecuteTime='2016-02-09 17:24')

Cancel Scheduled Climate Control:

leaf.ACRemoteCancelRequest()

Get Climate Control Schedule:

leaf.GetScheduledACRemoteRequest()

Get Driving Analysis:

leaf.DriveAnalysisBasicScreenRequestEx()

Get Price Simulation:

leaf.PriceSimulatorDetailInfoRequest()