sensors 2.0.3 sensors: ^2.0.3 copied to clipboard
Flutter plugin for accessing the Android and iOS accelerometer and gyroscope sensors.
sensors #
Deprecation Notice #
This plugin has been replaced by the Flutter Community Plus
Plugins version,
sensors_plus
.
No further updates are planned to this plugin, and we encourage all users to
migrate to the Plus version.
Critical fixes (e.g., for any security incidents) will be provided through the end of 2021, at which point this package will be marked as discontinued.
A Flutter plugin to access the accelerometer and gyroscope sensors.
Usage #
To use this plugin, add sensors
as a dependency in your pubspec.yaml
file.
This will expose three classes of sensor events, through three different streams.
AccelerometerEvent
s describe the velocity of the device, including the effects of gravity. Put simply, you can use accelerometer readings to tell if the device is moving in a particular direction.UserAccelerometerEvent
s also describe the velocity of the device, but don't include gravity. They can also be thought of as just the user's affect on the device.GyroscopeEvent
s describe the rotation of the device.
Each of these is exposed through a BroadcastStream
: accelerometerEvents
,
userAccelerometerEvents
, and gyroscopeEvents
, respectively.
Example #
import 'package:sensors/sensors.dart';
accelerometerEvents.listen((AccelerometerEvent event) {
print(event);
});
// [AccelerometerEvent (x: 0.0, y: 9.8, z: 0.0)]
userAccelerometerEvents.listen((UserAccelerometerEvent event) {
print(event);
});
// [UserAccelerometerEvent (x: 0.0, y: 0.0, z: 0.0)]
gyroscopeEvents.listen((GyroscopeEvent event) {
print(event);
});
// [GyroscopeEvent (x: 0.0, y: 0.0, z: 0.0)]
Also see the example
subdirectory for an example application that uses the
sensor data.