Skip to content
This repository has been archived by the owner on Oct 18, 2021. It is now read-only.

Commit

Permalink
Update README for 2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
biqqles committed Sep 17, 2018
1 parent e622b9d commit daa7baa
Showing 1 changed file with 36 additions and 20 deletions.
56 changes: 36 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,51 @@
# Nextlit
[Jump to source](app/src/main/java/eu/biqqles/nextlit/)
[Jump to source](app/src/main/java/eu/biqqles/nextlit/) | [Screenshots](https://forum.xda-developers.com/devdb/project/?id=24361#screenshots)

**Nextlit** is a simple app which activates the [LP5523](http://www.ti.com/product/LP5523)-controlled segmented LEDs on the back of the [Nextbit Robin](https://en.wikipedia.org/wiki/Nextbit_Robin) and employs them as a fancy notification light. It's something I'd seen quite a few people asking for, and after playing around with the kernel interface for a bit I realised that it's pretty simple to utilise these lights for purposes beyond their rather limited use in the stock ROM. Nextlit has been [featured on XDA](https://www.xda-developers.com/nextlit-nextbit-robin-led-notifications/).
The [LP5523](http://www.ti.com/product/LP5523)-controlled segmented LEDs on the rear of the [Nextbit Robin](https://en.wikipedia.org/wiki/Nextbit_Robin) are one of the device's most unique features. Yet they see very little use, being used only for effects relating to the now-defunct "Smart Storage" in the stock ROM and simply displaying a pattern during boot in custom ROMs. Nextlit rectifies this by employing these lights as a useful notification indicator.

Nextlit is very much a work in progress. The app allows you to preview the five patterns programmed into the LP5523 by Nextbit as well as some "custom" ones unique to the app, and select one to activate when a notification is received. You can configure whether the lights should be enabled while the screen is on, and additionally whether they should be activated by ongoing notifications (e.g. music player controls).
Nextlit allows you to preview the five patterns programmed into the LP5523 by Nextbit plus another five unique to the app, and select one to activate when a notification is received. You can configure patterns for individual apps, letting you identify which app requires your attention without needing to wake your phone. Nextlit exploits the potential of the segmented LEDs to encode greater meaning than can be expressed with the standard notification light and looks cool while doing it.

If you want to use the app for any more than just previewing the available patterns, you'll need to give it notification access. The application does not read or care about the contents of notifications; the only thing is does is count them. Make sure to disable charging indication in Settings if your ROM supports it and you want to see notifications while charging.
If you want to use the app for any more than simply previewing the available patterns you'll need to give its service notification access. The application does not read nor care about the contents of notifications; the only thing it does is count them. You can see the relevant routines [here](app/src/main/java/eu/biqqles/nextlit/NotificationLightsService.java).

The app needs root in order to write to `/sys` but will work on any ROM. Nextlit is released under the Mozilla General Public License version 2.0.
The app needs root access in order to access `/sys` but will work on any ROM. Nextlit has been [featured on XDA](https://www.xda-developers.com/nextlit-nextbit-robin-led-notifications/) and is free software, released under the Mozilla General Public License version 2.0.

### To do
- ~~‎custom patterns~~ [done]
- ~~make service persistent between reboots~~ [done]
- customisation: per-app settings, ~~show only when screen off~~ [done], show only for unseen notifications etc.
- user-defined patterns
- pattern execution emulation (on-screen previews)
- user-definable patterns
- necessitates an [assembler for the LP5523's instruction set](http://www.ti.com/lit/zip/snvc151)
- music visualisation
- BCD clock
- (optionally) disable lights while charging

### Changelog

*1.2*
- Fix possible force close on unrooted devices
#### 2.0
- First release marked as 'stable'
- Completely overhauled UI
- Added app icon
- Added per-app notification configuration
- Added five new patterns: Breathe, Pulse, Chase, Blink and Dapple
- By default, notifications will now only activate the lights if they would normally activate the standard notification LED
- Calls and alarms now activate the lights
- Added service configuration options:
- Obey Do not disturb policy
- Mimic standard LED behaviour (experimental)
- Minor changes:
- Improved service stability
- Fixed preview not stopping if service not bound
- Renamed 'show for ongoing' to 'show for all notifications' to better reflect its function
- Preview now ends on app pause
- Service will now disable if unbound

#### 1.2
- Fixed possible force close on unrooted devices
- Service is now persistent between reboots
- Add 'show for ongoing notifications' option (default behaviour is false)
- Added 'show for ongoing notifications' option

*1.1*
- Add option to enable lights when screen on (default behaviour is false)
#### 1.1
- Added option to enable lights when screen on

*1.0.1*
- Fix possible force close on service enable
- Fix service failing to stop
#### 1.0.1
- Fixed possible force close on service enable
- Fixed service failing to stop

*1.0*
#### 1.0
- Initial release

0 comments on commit daa7baa

Please sign in to comment.