commit	9e8f52f7d97e3de932e4e366f8ed226eea6326b5	[log] [tgz]
author	Simon Shields <simonshields@google.com>	Sun Jun 26 23:46:55 2022 +0000
committer	CQ Bot <fuchsia-internal-scoped@luci-project-accounts.iam.gserviceaccount.com>	Sun Jun 26 23:46:55 2022 +0000
tree	30297b78b12891d1348cb6867d462083b2992759
parent	044c7aefe4cc93e9bc34cd5b909ad336b23b97ca [diff]

tree: 30297b78b12891d1348cb6867d462083b2992759

README.md

Fuchsia samples using the Fuchsia SDK

This repository contains instructions and source code to build, package and run Fuchsia samples using only the Fuchsia SDK. To update the dependencies of this repository, follow the instructions in update_dependencies.md.

Requirements

Install Bazel version 5.1 or later by following the instructions at https://bazel.build/install. In some Linux distributions, sudo apt-get install bazel should be enough.
Make sure this repository has the required submodules:
```
git submodule update --recursive --init
```

Ensure that there are Fuchsia SSH keys in your host machine. You will need them for running the Fuchsia emulator.

 [[ -f "${HOME}/.ssh/fuchsia_ed25519" ]] || ssh-keygen -P "" -t ed25519 -f "${HOME}/.ssh/fuchsia_ed25519" -C "${USER}@$(hostname -f) Shared SSH Key for Fuchsia"

 [[ -f "${HOME}/.ssh/fuchsia_authorized_keys" ]] || ssh-keygen -y -f "${HOME}/.ssh/fuchsia_ed25519" > "${HOME}/.ssh/fuchsia_authorized_keys"

Build, run and test the samples

Now the repository is ready to build the samples.

Build the samples:
Note: in order to use an SDK produced by a local Fuchsia platform tree, you can set an environment variable named LOCAL_FUCHSIA_PLATFORM_BUILD as described in https://fuchsia.googlesource.com/sdk-integration/+/0503b02c059a6de76242280b467898358ba30ae3
```
bazel build --config=fuchsia_x64 src:samples_repository
```
This command will build and package all the samples.

If using an emmulator:

Fetch the system images

tools/ffx product-bundle get workstation.qemu-x64

Start the emulator

tools/ffx emu start workstation.qemu-x64 --headless \
   --kernel-args "driver_manager.use_driver_framework_v2=true" \
   --kernel-args "driver_manager.root-driver=fuchsia-boot:///#meta/platform-bus.cm" \
   --kernel-args "devmgr.enable-ephemeral=true"

The product bundle comes with on-demand packages in a separate repository. Use the following command to register it with the emulator:
```
tools/ffx target repository register -r workstation.qemu-x64 --alias fuchsia.com
```

If using a physical device like a Pixelbook Go:
1. Fetch the system images
```
tools/ffx product-bundle get workstation.qemu-x64-dfv2
```
2. Prepare and connect the Pixelbook Go, by flashing and/or paving it (not covered here), and connect using Ethernet.
3. The product bundle comes with on-demand packages in a separate repository. Use the following command to register it with the device:
```
tools/ffx target repository register -r workstation.qemu-x64-dfv2 --alias fuchsia.com
```
4. Update (OTA) the device to the version of the SDK:
```
tools/ffx target update check-now --monitor
```
(optional) watch the device log in a separate window
```
tools/ffx log
```
Load the sample drivers
Now you are ready to register a driver. Starting with the example driver:
First, let's confirm that the driver is not loaded:
```
tools/ffx driver list | grep example_driver
```
The command above should not return any driver named “example_driver” because it has not been registered.
Now register the driver:
```
bazel run --config=fuchsia_x64 src/example_driver:pkg.component
```
The driver now should show in the list of loaded drivers:
```
tools/ffx driver list | grep example_driver
fuchsia-pkg://bazel.pkg.component/example_driver#meta/example_driver.cm
```
You can also watch in the log to see if the driver is loaded correctly. The ffx log window should show a message similar to:
```
[88.961][bootstrap/driver_manager][driver_manager.cm][I] Loaded driver 'fuchsia-pkg://bazel.pkg.component/example_driver#meta/example_driver.cm'
```