#custom-embedders
channel on the flutter discord which you can use if you have any questions regarding flutter-pi or generally, anything related to embedding the engine for which you don't want to open issue about or write an email.gen_snapshot_linux_x64
was renamed to gen_snapshot_linux_x64_release
.681e399
A light-weight Flutter Engine Embedder for Raspberry Pi. Inspired by https://github.com/chinmaygarde/flutter_from_scratch. Flutter-pi also runs without X11, so you don't need to boot into Raspbian Desktop & have X11 and LXDE load up; just boot into the command-line.
You can now theoretically run every flutter app you want using flutter-pi, including apps using packages & plugins, just that you'd have to build the platform side of the plugins you'd like to use yourself.
The difference between packages and plugins is that packages don't include any native code, they are just pure Dart. Plugins (like the connectivity plugin) include platform-specific code.
Although flutter-pi is only tested on a Rasberry Pi 4 2GB, it should work fine on other linux platforms, with the following conditions:
This means flutter-pi won't work on a Pi Zero or Pi 1. A Pi 3 works fine, even the 512MB A+ model, and a Pi 2 should work fine too.
If you encounter issues running flutter-pi on any of the supported platforms listed above, please report them to me and I'll fix them.
app.so
(for running your app in Release/Profile mode)git pull && git checkout origin/master
and continue with compiling, step 2.Install the flutter engine binaries using the instructions in the in the flutter-engine-binaries-for-arm repo..
flutter-pi needs flutters flutter_embedder.h
to compile and icudtl.dat
at runtime. It also needs libflutter_engine.so.release
at runtime when invoked with the --release
flag and libflutter_engine.so.debug
when invoked without.
You actually have two options here:
Install cmake, graphics, system libraries and fonts:
sudo apt install cmake libgl1-mesa-dev libgles2-mesa-dev libegl1-mesa-dev libdrm-dev libgbm-dev ttf-mscorefonts-installer fontconfig libsystemd-dev libinput-dev libudev-dev libxkbcommon-dev
libsystemd
is not systemd, it's just an utility library. It provides the event loop and dbus support for flutter-pi.libinput-dev
, libudev-dev
and libxkbcommon-dev
are needed for (touch, mouse, raw keyboard and text) input support.libudev-dev
is required, but actual udev is not. Flutter-pi will just open all event
devices inside /dev/input
(unless overwritten using -i
) if udev is not present.gpiod
and libgpiod-dev
where required in the past, but aren't anymore since the flutter_gpiod
plugin will directly access the kernel interface.Update the system fonts.
sudo fc-cache
git clone https://github.com/ardera/flutter-pi
cd flutter-pi
mkdir build && cd build
cmake ..
make -j`nproc`
sudo make install
Open raspi-config:
sudo raspi-config
Switch to console mode:
System Options -> Boot / Auto Login
and select Console
or Console (Autologin)
.
Enable the V3D graphics driver
Advanced Options -> GL Driver -> GL (Fake KMS)
Configure the GPU memory
Performance Options -> GPU Memory
and enter 64
.
Leave raspi-config
.
Give the pi
permission to use 3D acceleration. (NOTE: potential security hazard. If you don't want to do this, launch flutter-pi
using sudo
instead.)
usermod -a -G render pi
Finish and reboot.
omxplayer_video_player
plugin.pi
isn't allowed to directly access the GPU because IIRC this has some privilege escalation bugs. Raspberry Pi has quite a lot of system-critical, not graphics-related stuff running on the GPU. I read somewhere it's easily possible to gain control of the GPU by writing malicious shaders. From there you can gain control of the CPU and thus the linux kernel. So basically the pi
user could escalate privileges and become root
just by directly accessing the GPU. But maybe this has already been fixed, I'm not sure.Make sure you've installed the flutter SDK. You must use a flutter SDK that's compatible to the installed engine binaries.
If you encounter error messages like Invalid kernel binary format version
, Invalid SDK hash
or Invalid engine hash
:
stable
and up to date and your engine binaries are up to date.Open terminal or commandline and cd
into your app directory.
flutter build bundle
Deploy the asset bundle to the Raspberry Pi using rsync
or scp
.
rsync
(available on linux and macOS or on Windows when using WSL)rsync -a --info=progress2 ./build/flutter_assets/ pi@raspberrypi:/home/pi/my_apps_flutter_assets
scp
(available on linux, macOS and Windows)scp -r ./build/flutter_assets/ pi@raspberrypi:/home/pi/my_apps_flutter_assets
flutter_gallery
and deploy it using rsync
in this example.git clone https://github.com/flutter/gallery.git flutter_gallery
cd flutter_gallery
git checkout 681e399ba983631ba9e20590fe7a6121731825f1
flutter build bundle
rsync -a ./build/flutter_assets/ pi@raspberrypi:/home/pi/flutter_gallery/
flutter-pi /home/pi/flutter_gallery
.681e399ba983631ba9e20590fe7a6121731825f1
is currently the latest flutter gallery
commit working flutter stable.app.so
(for running your app in Release/Profile mode)Find out the path to your flutter SDK. For me it's C:\flutter
. (I'm on Windows)
Open terminal or commandline and cd
into your app directory.
Build the asset bundle.
flutter build bundle
Build the kernel snapshot. (Replace my_app_name
with the name of your app)
C:\flutter\bin\cache\dart-sdk\bin\dart.exe ^
C:\flutter\bin\cache\dart-sdk\bin\snapshots\frontend_server.dart.snapshot ^
--sdk-root C:\flutter\bin\cache\artifacts\engine\common\flutter_patched_sdk_product ^
--target=flutter ^
--aot ^
--tfa ^
-Ddart.vm.product=true ^
--packages .packages ^
--output-dill build\kernel_snapshot.dill ^
--verbose ^
--depfile build\kernel_snapshot.d ^
package:my_app_name/main.dart
Fetch the latest gen_snapshot_linux_x64_release
I provide in the engine binaries repo.
The following steps must be executed on a linux x64 machine. If you're on windows, you can use WSL. If you're on macOS, you can use a linux VM.
Build the app.so
.
gen_snapshot_linux_x64_release \
--deterministic \
--snapshot_kind=app-aot-elf \
--elf=build/flutter_assets/app.so \
--strip \
--sim-use-hardfp \
build/kernel_snapshot.dill
Now you can switch to your normal OS again.
Upload the asset bundle and the app.so
to your Raspberry Pi.
rsync -a --info=progress2 ./build/flutter_assets/ pi@raspberrypi:/home/pi/my_app
or
scp -r ./build/flutter_assets/ pi@raspberrypi:/home/pi/my_app
You can now launch the app in release mode using flutter-pi --release /home/pi/my_app
flutter_gallery
and deploy it using rsync
in this example.git clone https://github.com/flutter/gallery.git flutter_gallery
git clone --depth 1 https://github.com/ardera/flutter-engine-binaries-for-arm.git engine-binaries
cd flutter_gallery
git checkout 681e399ba983631ba9e20590fe7a6121731825f1
flutter build bundle
C:\flutter\bin\cache\dart-sdk\bin\dart.exe ^
C:\flutter\bin\cache\dart-sdk\bin\snapshots\frontend_server.dart.snapshot ^
--sdk-root C:\flutter\bin\cache\artifacts\engine\common\flutter_patched_sdk_product ^
--target=flutter ^
--aot ^
--tfa ^
-Ddart.vm.product=true ^
--packages .packages ^
--output-dill build\kernel_snapshot.dill ^
--verbose ^
--depfile build\kernel_snapshot.d ^
package:gallery/main.dart
wsl
../engine-binaries/arm/gen_snapshot_linux_x64_release \
--deterministic \
--snapshot_kind=app-aot-elf \
--elf=build/flutter_assets/app.so \
--strip \
--sim-use-hardfp \
build/kernel_snapshot.dill
rsync -a --info=progress2 ./build/flutter_assets/ pi@raspberrypi:/home/pi/flutter_gallery/
exit
flutter-pi --release /home/pi/flutter_gallery
.USAGE:
flutter-pi [options] <asset bundle path> [flutter engine options]
OPTIONS:
--release Run the app in release mode. The AOT snapshot
of the app ("app.so") must be located inside the
asset bundle directory.
This also requires a libflutter_engine.so that was
built with --runtime-mode=release.
-o, --orientation <orientation> Start the app in this orientation. Valid
for <orientation> are: portrait_up, landscape_left,
portrait_down, landscape_right.
For more information about this orientation, see
the flutter docs for the "DeviceOrientation"
enum.
Only one of the --orientation and --rotation
options can be specified.
-r, --rotation <degrees> Start the app with this rotation. This is just an
alternative, more intuitive way to specify the
startup orientation. The angle is in degrees and
clock-wise.
Valid values are 0, 90, 180 and 270.
-d, --dimensions "width_mm,height_mm" The width & height of your display in
millimeters. Useful if your GPU doesn't provide
valid physical dimensions for your display.
The physical dimensions of your display are used
to calculate the flutter device-pixel-ratio, which
in turn basically "scales" the UI.
-i, --input <glob pattern> Appends all files matching this glob pattern to the
list of input (touchscreen, mouse, touchpad,
keyboard) devices. Brace and tilde expansion is
enabled.
Every file that matches this pattern, but is not
a valid touchscreen / -pad, mouse or keyboard is
silently ignored.
If no -i options are given, flutter-pi will try to
use all input devices assigned to udev seat0.
If that fails, or udev is not installed, flutter-pi
will fallback to using all devices matching
"/dev/input/event*" as inputs.
In most cases, there's no need to specify this
option.
Note that you need to properly escape each glob
pattern you use as a parameter so it isn't
implicitly expanded by your shell.
-h, --help Show this help and exit.
EXAMPLES:
flutter-pi ~/hello_world_app
flutter-pi --release ~/hello_world_app
flutter-pi -o portrait_up ./my_app
flutter-pi -r 90 ./my_app
flutter-pi -d "155, 86" ./my_app
SEE ALSO:
Author: Hannes Winkler, a.k.a ardera
Source: https://github.com/ardera/flutter-pi
License: MIT
For instructions on how to build an asset bundle or an AOT snapshot
of your app, please see the linked git repository.
For a list of options you can pass to the flutter engine, look here:
https://github.com/flutter/engine/blob/master/shell/common/switches.h
<asset bundle path>
is the path of the flutter asset bundle directory (i.e. the directory containing kernel_blob.bin
)
of the flutter app you're trying to run.
[flutter engine options...]
will be passed as commandline arguments to the flutter engine. You can find a list of commandline options for the flutter engine Here.
Graphics performance is actually pretty good. With most of the apps inside the flutter SDK -> examples -> catalog
directory I get smooth 50-60fps on the Pi 4 2GB and Pi 3 A+.
Due to the way the touchscreen driver works in raspbian, there's some delta between an actual touch of the touchscreen and a touch event arriving at userspace. The touchscreen driver in the raspbian kernel actually just repeatedly polls some buffer shared with the firmware running on the VideoCore, and the videocore repeatedly polls the touchscreen. (both at 60Hz) So on average, there's a delay of 17ms (minimum 0ms, maximum 34ms). Actually, the firmware is polling correctly at ~60Hz, but the linux driver is not because there's a bug. The linux side actually polls at 25Hz, which makes touch applications look terrible. (When you drag something in a touch application, but the application only gets new touch data at 25Hz, it'll look like the application itself is redrawing at 25Hz, making it look very laggy) The github issue for this raspberry pi kernel bug is here. Leave a like on the issue if you'd like to see this fixed in the kernel.
This is why I created my own (userspace) touchscreen driver, for improved latency & polling rate. See this repo for details. The driver is very easy to use and the difference is noticeable, flutter apps look and feel a lot better with this driver.
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。