# nest_gen2 v0.6.6 - Table of Contents

> Run your own Elixir app on a Wi-Fi-connected Nest Learning Thermostat (2nd gen) rooted with No Longer Evil: round display, dial and press, piezo, motion, light and climate sensors, Wi-Fi setup, and scripts to install it and deploy apps.

## Pages

- [nest_gen2](readme.md)
- [From a Nest thermostat to your own Elixir app](install.md)
- [nest_gen2_sdk — public Elixir API (draft)](api.md)
- [Power, battery and sleep](power.md)
- [Running your app on a computer](host.md)
- [The backplate: hardware and protocol](backplate.md)
- [Changelog](changelog.md)

## Modules

- [NestGen2](NestGen2.md): SDK for a rooted Nest Learning Thermostat (2nd gen).
- [NestGen2.Backlight](NestGen2.Backlight.md): The LM3530 backlight.
- [NestGen2.Backplate](NestGen2.Backplate.md): The link to the backplate (or desk stand) microcontroller on `/dev/ttyO2`.
- [NestGen2.Battery](NestGen2.Battery.md): The head unit's battery voltage, as reported by the backplate.
- [NestGen2.Climate](NestGen2.Climate.md): Temperature and humidity from the backplate, every ~30 s.
- [NestGen2.Clock](NestGen2.Clock.md): Keeps the system clock (UTC) right.
- [NestGen2.Dial](NestGen2.Dial.md): The ring and its press.
- [NestGen2.Display](NestGen2.Display.md): The 320×320 round screen, double-buffered.
- [NestGen2.Gesture](NestGen2.Gesture.md): Clicks, double clicks and long presses, from the button's raw `:down` and
`:up` events. Subscribe to `:gesture` to receive
- [NestGen2.Host](NestGen2.Host.md): Running an app on a computer instead of a Nest, for developing and testing
screens without deploying (see `docs/host.md`).
- [NestGen2.Host.Viewer](NestGen2.Host.Viewer.md): The Nest's screen in a browser, when running on a computer (`target: :host`).
- [NestGen2.Image](NestGen2.Image.md): A block of pixels in the framebuffer's own format: 4 bytes per pixel, BGRX.
- [NestGen2.Light](NestGen2.Light.md): The backplate's ambient light sensor (raw counts, once a second).
- [NestGen2.Motion](NestGen2.Motion.md): The backplate's passive-infrared motion sensors (near and far).
- [NestGen2.Network](NestGen2.Network.md): Name resolution that doesn't depend on Nest's connection manager.
- [NestGen2.Piezo](NestGen2.Piezo.md): The piezo buzzer (pwm-beeper on `/dev/input/event0`).
- [NestGen2.Power](NestGen2.Power.md): Screen wake and sleep.
- [NestGen2.Storage](NestGen2.Storage.md): Settings that survive restarts and power cuts, for apps.
- [NestGen2.Text](NestGen2.Text.md): Text rendering from Nest's own Akkurat fonts, on the device.
- [NestGen2.Wifi](NestGen2.Wifi.md): Wi-Fi: status, scanning, joining a network, and saved networks.

## Mix Tasks

- [mix nest_gen2.host](Mix.Tasks.NestGen2.Host.md): Builds the text renderer for this computer and checks the fonts, so an app
can run here with `config :nest_gen2, target: :host` (see `docs/host.md`).