Skip to content

Uses the No Longer Evil API to integrate the jailbroken thermostats into Home Assistant

License

Notifications You must be signed in to change notification settings

patricktr/NoLongerEvil-HomeAssistant

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

No Longer Evil - Home Assistant Integration

hacs_badge GitHub Release License

A Home Assistant integration for No Longer Evil - providing local and cloud control of your smart thermostat.

Features

  • Climate Control: Full thermostat control including temperature, HVAC modes, and fan modes
  • Temperature Monitoring: Real-time temperature sensors
  • HVAC Status: Binary sensors for heating, cooling, and fan activity
  • Away Mode: Switch to enable/disable away mode for energy savings
  • Temperature Range: Support for heat-cool mode with temperature ranges
  • Multiple Devices: Support for multiple thermostats per account

Installation

HACS (Recommended)

  1. Open HACS in your Home Assistant instance
  2. Click on "Integrations"
  3. Click the three dots in the top right corner
  4. Select "Custom repositories"
  5. Add this repository URL: https://github.com/patricktr/NoLongerEvil-HomeAssistant
  6. Select "Integration" as the category
  7. Click "Add"
  8. Search for "No Longer Evil" and install it
  9. Restart Home Assistant

Manual Installation

  1. Download the latest release from the releases page
  2. Extract the custom_components/nolongerevil folder to your Home Assistant custom_components directory
  3. Restart Home Assistant

Configuration

Getting an API Key

  1. Go to No Longer Evil Settings
  2. Navigate to the API Keys section
  3. Create a new API key with the following scopes:
    • read - Required for reading device status
    • write - Required for controlling devices
  4. Copy the generated API key (it starts with nle_)

Adding the Integration

  1. Go to Settings > Devices & Services
  2. Click + Add Integration
  3. Search for "No Longer Evil"
  4. Enter your API key
  5. (Optional) If you're using a self-hosted instance, enter your custom API URL

Entities

Climate

The main climate entity provides full thermostat control:

  • Current Temperature: The current room temperature
  • Target Temperature: Set your desired temperature
  • HVAC Mode: Off, Heat, Cool, or Heat-Cool (Auto)
  • Fan Mode: Auto, On, or Off
  • Preset Mode: Home, Away, or Eco

Sensors

Entity Description
Current Temperature Current room temperature reading
Target Temperature Currently set target temperature
HVAC Action Current action (heating, cooling, idle, fan)

Binary Sensors

Entity Description
Heating On when the heater is actively running
Cooling On when the AC is actively running
Fan Running On when the fan is running
Home On when home (not in away mode)

Switches

Entity Description
Away Mode Toggle away mode on/off

Options

You can configure the following options after installation:

Option Description Default
Scan Interval How often to poll for updates (seconds) 30

Self-Hosted Users

If you're running a self-hosted No Longer Evil instance:

  1. During setup, enter your custom API base URL
  2. Example: http://your-server:3000/api/v1

Troubleshooting

Authentication Errors

  • Ensure your API key is correct and has both read and write scopes
  • Check that the API key hasn't been revoked in your account settings

No Devices Found

  • Make sure you have at least one thermostat registered to your account
  • Verify the API key has access to your devices

Connection Issues

  • Check your network connection
  • For self-hosted users, ensure your server is reachable
  • The API rate limit is 20 requests per minute for API keys

Rate Limiting

The No Longer Evil API has rate limits:

  • API keys: 20 requests per minute
  • User accounts: 100 requests per minute

If you see rate limit errors, increase the scan interval in the integration options.

Support

Contributing

Contributions are welcome! Please read our contributing guidelines before submitting pull requests.

License

This project is licensed under the MIT License - see the LICENSE file for details.

About

Uses the No Longer Evil API to integrate the jailbroken thermostats into Home Assistant

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages