Skip to content

Update documentation for Virtual Peripheral example, enhancing descri… #3103

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
madeline-underwood wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update documentation for Virtual Peripheral example, enhancing descri… #3103

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion content/learning-paths/embedded-and-microcontrollers/avh_vio/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Implement an example Virtual Peripheral with Arm Virtual Hardware

description: Learn how to create and integrate a virtual LED peripheral using the Virtual IO interface of Arm Virtual Hardware to simulate real-world peripherals.

minutes_to_complete: 20

who_is_this_for: This is an introductory topic for software developers new to Arm Virtual Hardware and its features.
Expand All @@ -10,7 +12,7 @@ learning_objectives:

prerequisites:
- A valid [AWS](https://aws.amazon.com/) account
- Some familiarity with Python
- Some familiarity with Python

author: Pareena Verma

Expand Down
8 changes: 4 additions & 4 deletions content/learning-paths/embedded-and-microcontrollers/avh_vio/vio.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The example used here makes use of the [Tkinter](https://docs.python.org/3/libra
```console
sudo apt install -y python3-tk
```
## Clone the repository:
## Clone the repository

In your AVH terminal, clone the example project repository, and navigate into the `leds_example` directory.
```console
Expand All @@ -34,12 +34,12 @@ You can now run the executable on the AVH FVP by executing the following script:
```console
./run.sh
```
You can interact with the Virtual LEDs. If they are not displayed you may need to implement a [VNC connection](/install-guides/avh#vnc) to the AVH instance.
You can interact with the Virtual LEDs. If they're not displayed you may need to implement a [VNC connection](/install-guides/avh#vnc) to the AVH instance.

## Understand the example

The Virtual Hardware is launched with the `-V` option which specifies the python implementation of the peripheral.
The Virtual Hardware is launched with the `-V` option which specifies the Python implementation of the peripheral.

The python scripts implement the [VIO Python interface](https://arm-software.github.io/AVH/main/simulation/html/group__arm__vio__py.html) to communicate with the Virtual Hardware application.
The Python scripts implement the [VIO Python interface](https://arm-software.github.io/AVH/main/simulation/html/group__arm__vio__py.html) to communicate with the Virtual Hardware application.

In the application, signals are passed via the [VIO API](https://arm-software.github.io/AVH/main/simulation/html/group__arm__vio__api.html) to/from the virtual peripheral.
Loading