Skip to content

Commit

Permalink
clean code and update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
alexandre_poichet committed Aug 2, 2024
1 parent 6fccc1d commit 29b7f48
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 44 deletions.
72 changes: 39 additions & 33 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,13 @@

# flutter_eco_mode

A Flutter plugin to help implementing custom eco-friendly mode in your mobile app. This plugin will tell you if a device
is a low-end device or not according to our recommendations.
It will also give you brut data to allow you to implement
your own rules for your app.
A Flutter plugin to help implementing custom eco-friendly mode in your mobile app.

According to our recommendations, the plugin determine if a device is:
* a low-end device
* in a battery eco mode

**It will also give you your own rules for your app.**

This plugin is still in reflexion and development. And will only be available for Android and iOS at the moment.

Expand All @@ -22,37 +25,23 @@ also to offer a less energy-consuming app.

## Features

| Feature | Android | iOS | Runtime | Event |
|:---------------------------------------------------------------------------------------------------|:---------------------------------------:|:---------------------------------------:|:-------------------------------------:|:-----:|
| getPlatformInfo() | Yes | Yes | | |
| getBatteryLevel() | Yes | Yes | X | |
| getBatteryState() | No | Yes | X | |
| isBatteryInLowPowerMode() | Yes | Yes | X | |
| lowPowerModeEventStream() | Yes | Yes | X | X |
| getThermalState() | Yes | Yes | X | |
| getProcessorCount() | Yes | Yes | | |
| getTotalMemory() | Yes | Yes | | |
| getFreeMemory() | Yes | Yes | X | |
| getTotalStorage() | Yes | Yes | | |
| getFreeStorage() | Yes | Yes | X | |
| isBatteryEcoModeStream | Yes | No | | X |
| <span style="color: #3CB371">**isBatteryEcoMode()**</span> | <span style="color: #3CB371">Yes</span> | <span style="color: #3CB371">Yes</span> | <span style="color: #3CB371">X</span> | |
| <span style="color: #3CB371">**getEcoRange**()</span> | <span style="color: #3CB371">Yes</span> | <span style="color: #3CB371">Yes</span> | <span style="color: #3CB371">X</span> | |

| Feature | Android | iOS | Runtime | Event |
|:---------------------------------------------------------|:---------------------------------------:|:---------------------------------------:|:-------------------------------------:|:-------------------------------------:|
| Platform Info | Yes | Yes | X | |
| Processor Count | Yes | Yes | X | |
| Total Memory | Yes | Yes | X | |
| Free Memory | Yes | Yes | X | |
| Total Storage | Yes | Yes | X | |
| Free Storage | Yes | Yes | X | |
| <span style="color: #3CB371">**Eco Range**</span> | <span style="color: #3CB371">Yes</span> | <span style="color: #3CB371">Yes</span> | <span style="color: #3CB371">X</span> | <span style="color: #3CB371">X</span> |
| Battery Thermal State | Yes | Yes | X | |
| Battery State | Yes | Yes | X | X |
| Battery Level | Yes | Yes | X | X |
| Battery In Low Power Mode | Yes | Yes | X | X |
| <span style="color: #3CB371">**Battery Eco Mode**</span> | <span style="color: #3CB371">Yes</span> | <span style="color: #3CB371">Yes</span> | <span style="color: #3CB371">X</span> | <span style="color: #3CB371">X</span> |

## Eco Mode
### Battery Eco Mode

This feature combines different battery information to determine if the device is in **_eco-mode_** or not.
It will return a boolean.

```
Future.wait([
_isNotEnoughBattery(),
_isBatteryLowPowerMode(),
_isSeriousAtLeastBatteryState(),
])
```
### Eco Range
This feature gives the possibility to calculate a score for the device.
The score does NOT represent an ecological performance.
Expand All @@ -75,11 +64,28 @@ That's why we give you the possibility to calculate your own score by using othe
If you have more than three eco ranges in your custom eco-mode,
feel free to give the best user eco experience to your final users :)

### Battery Eco Mode

This feature combines different battery information to determine if the device is in **_eco-mode_** or not.
It will return a boolean.

```
@override
Stream<bool?> get isBatteryEcoModeStream => CombineLatestStream.list([
_isNotEnoughBatteryStream(),
lowPowerModeEventStream.withInitialValue(isBatteryInLowPowerMode()),
]).map((event) => event.any((element) => element)).asBroadcastStream();
Stream<bool> _isNotEnoughBatteryStream() => CombineLatestStream.list([
batteryLevelEventStream.map((event) => event.isNotEnough),
batteryStateEventStream.map((event) => event.isDischarging),
]).map((event) => event.every((element) => element)).asBroadcastStream();
```

## Example

See the `example` directory for a complete sample app using flutter_eco_mode.


## Contribution

We are open to any contributions or suggestions. If you have any questions, please contact us.
Expand Down
10 changes: 2 additions & 8 deletions example/lib/results.dart
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import 'package:flutter/material.dart';
import 'package:flutter_eco_mode/flutter_eco_mode.dart';

class ResultLine {
final String label;
Expand Down Expand Up @@ -93,7 +94,7 @@ class _ResultState extends State<_Result> {
super.initState();
_future = widget.future.call();
if (widget.stream != null) {
_stream = widget.stream!.call().initWith(_future);
_stream = widget.stream!.call().withInitialValue(_future);
}
}

Expand Down Expand Up @@ -171,10 +172,3 @@ class _ResultDecoration extends StatelessWidget {
);
}
}

extension StreamExtension<T> on Stream<T> {
Stream<T> initWith(Future<T> value) async* {
yield await value;
yield* this;
}
}
5 changes: 2 additions & 3 deletions lib/flutter_eco_mode.dart
View file
Original file line number Diff line number Diff line change
Expand Up @@ -195,8 +195,7 @@ class FlutterEcoMode extends FlutterEcoModePlatform {
@override
Stream<bool?> get isBatteryEcoModeStream => CombineLatestStream.list([
_isNotEnoughBatteryStream(),
lowPowerModeEventStream.withInitialValue(
isBatteryInLowPowerMode().then((value) => value ?? false)),
lowPowerModeEventStream.withInitialValue(isBatteryInLowPowerMode()),
]).map((event) => event.any((element) => element)).asBroadcastStream();

Stream<bool> _isNotEnoughBatteryStream() => CombineLatestStream.list([
Expand All @@ -218,7 +217,7 @@ extension on ThermalState {
this == ThermalState.serious || this == ThermalState.critical;
}

extension _StreamExtensions<T> on Stream<T> {
extension StreamExtensions<T> on Stream<T> {
Stream<T> withInitialValue(Future<T> value) async* {
yield await value;
yield* this;
Expand Down

0 comments on commit 29b7f48

Please sign in to comment.