https://github.com/a-mabe/background_hiit_timer
Flutter background timer package developed for OpenHIIT
https://github.com/a-mabe/background_hiit_timer
background-service background-timer flutter flutter-package openhiit timer
Last synced: about 1 month ago
JSON representation
Flutter background timer package developed for OpenHIIT
- Host: GitHub
- URL: https://github.com/a-mabe/background_hiit_timer
- Owner: a-mabe
- License: mit
- Created: 2023-08-07T18:17:21.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-12T20:59:23.000Z (3 months ago)
- Last Synced: 2025-04-13T02:28:03.901Z (3 months ago)
- Topics: background-service, background-timer, flutter, flutter-package, openhiit, timer
- Language: Dart
- Homepage:
- Size: 3.19 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# background_hiit_timer
A Flutter package for creating a high-intensity interval training (HIIT) timer with background service capabilities. Originally created for [OpenHIIT](https://github.com/a-mabe/OpenHIIT).
---
## Table of Contents
1. [Installation](#installation)
1. [Basic Usage](#basic-usage)
1. [Example Usage](#example-usage)
1. [Advanced Configuration](#Advanced-Configuration)
1. [Contributing](#Contributing)
1. [Code of Conduct](#Code-of-Conduct)
1. [Credits](#credits)
1. [License](#license)
---
## Installation
Add `background_hiit_timer` to your `pubspec.yaml` file:
```yaml
dependencies:
flutter:
sdk: flutter
background_hiit_timer: ^1.0.0
```
## Basic Usage
Import `background_hiit_timer` in your Dart file:
```dart
import 'package:background_hiit_timer/background_hiit_timer.dart';
```
1. Ensure that your app is properly configured to handle background execution on both Android and iOS platforms. Refer to [flutter_background_service](https://pub.dev/packages/flutter_background_service) for details.
2. Define a set of intervals:
```
final List intervals = [
IntervalType(
id: "0",
workoutId: "1",
time: 10, // in seconds
name: "Get ready",
color: 0,
intervalIndex: 0,
startSound: "",
halfwaySound: "",
countdownSound: "countdown-beep",
endSound: ""),
...
IntervalType(
id: "4",
workoutId: "1",
time: 10, // in seconds
name: "Cooldown",
color: 0,
intervalIndex: 4,
startSound: "long-rest-beep",
countdownSound: "countdown-beep",
endSound: "horn",
halfwaySound: ""),
];
```
3. Define a controller:
```
final CountdownController _controller = CountdownController(autoStart: true);
```
4. Create a `Countdown` widget and configure it with your interval settings:
```dart
Countdown(
controller: _controller,
intervals: intervals,
onFinished: () {},
build: (_, TimerState timerState) {
Text(timerState.currentMicroSeconds.toString())
}
)
```
### Example Usage
Check out the [example](example) directory in this repository for a complete example of how to use `background_hiit_timer` in a Flutter app.
## Advanced Configuration
For more advanced information, view [the advanced configuration documentation](./doc/advanced_configuration.md).
## Contributing
View the [contributing documentation](./CONTRIBUTING.md). If contributing code changes, please checkout the [testing documentation](./doc/testing.md).
### Code of Conduct
When contributing, please keep the [Code of Conduct](./CODE_OF_CONDUCT.md) in mind.
## Credits
This package is inspired by the [`timer_count_down`](https://pub.dev/packages/timer_count_down) package by [Dizoft Team](https://github.com/DizoftTeam).
Shoutout to [`flutter_background_service`](https://pub.dev/packages/flutter_background_service) for making the background timer possible.
## License
MIT License. See [LICENSE](LICENSE) for details.