-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update Website with new Getting Started Exercise (#213)
* Update website home page * Update documentation page to give more relevant info * Update top nav-bar * Add developer names * Add skeleton of basic tutorial * Add new getting_started example * Fix typo * Update HomePage to reflect new getting started page * Updates for getting started
- Loading branch information
1 parent
8da946b
commit ddd5a0c
Showing
16 changed files
with
184 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
title: Getting Started | ||
title: RoboticsAcademy with Visual Circuit | ||
layout: posts | ||
permalink: /follow_road/ | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,151 @@ | ||
--- | ||
title: Getting Started | ||
layout: posts | ||
permalink: /getting_started/ | ||
|
||
collection: posts | ||
|
||
classes: wide | ||
|
||
sidebar: | ||
nav: "docs" | ||
|
||
gallery: | ||
- url: /assets/images/follow_road/follow_road.jpg | ||
image_path: /assets/images/follow_road/follow_road.jpg | ||
alt: "Follow Road." | ||
title: "Follow Road." | ||
|
||
select: | ||
- url: /assets/images/getting_started/select_blocks.png | ||
image_path: /assets/images/getting_started/select_blocks.png | ||
alt: "Select Blocks" | ||
title: "Select Blocks" | ||
|
||
skeleton: | ||
- url: /assets/images/getting_started/skeleton_structure.png | ||
image_path: /assets/images/getting_started/skeleton_structure.png | ||
alt: "Skeleton of Circuit" | ||
title: "Skeleton of Circuit" | ||
|
||
internals: | ||
|
||
- url: /assets/images/getting_started/camera.png | ||
image_path: /assets/images/getting_started/camera.png | ||
alt: "Camera" | ||
title: "Camera" | ||
|
||
- url: /assets/images/getting_started/colour_filter.png | ||
image_path: /assets/images/getting_started/colour_filter.png | ||
alt: "Colour Filter" | ||
title: "Colour Filter" | ||
|
||
- url: /assets/images/getting_started/screen.png | ||
image_path: /assets/images/getting_started/screen.png | ||
alt: "Screen" | ||
title: "Screen" | ||
|
||
download: | ||
- url: /assets/images/getting_started/download.png | ||
image_path: /assets/images/getting_started/download.png | ||
alt: "Download Page" | ||
title: "Download Page" | ||
|
||
files: | ||
- url: /assets/images/getting_started/files.png | ||
image_path: /assets/images/getting_started/files.png | ||
alt: "Files" | ||
title: "Files" | ||
|
||
|
||
demo: | ||
- url: /assets/images/getting_started/demo.png | ||
image_path: /assets/images/getting_started/demo.png | ||
alt: "Demo" | ||
title: "Demo" | ||
|
||
--- | ||
|
||
## Goal | ||
The goal of this is to get your first Visual Circuit application up and running. Through the course of this tutorial we will build a simple Colour Filter using our OpenCV Blocks. | ||
|
||
### Installation | ||
The installation instructions can be found [here](/install/) | ||
|
||
### Starting Visual Circuit | ||
If you are accessing Visual Circuit online then simply open the webpage. | ||
|
||
However, if you are running Visual Circuit locally then: | ||
|
||
Start the frontend | ||
```bash | ||
cd frontend/ | ||
npm start | ||
``` | ||
|
||
Start the backend | ||
```bash | ||
cd backend | ||
python3 manage.py runserver | ||
``` | ||
|
||
### Connecting the Blocks | ||
|
||
We will need three blocks for this exercise: | ||
- Camera | ||
- Colour Filter | ||
- Screen | ||
|
||
#### Camera | ||
|
||
The Camera Block uses OpenCV to connect to your device's camera and start a video feed. | ||
|
||
#### Colour Filter | ||
|
||
The colour filter uses a range of HSV values in order to accurately detect the colour that we want in the image/video. | ||
|
||
#### Screen | ||
|
||
The screen block opens a window to display the feed coming from the Colour Filter block. | ||
|
||
All the data that is passed between blocks is done via the wires and the use of the `share` function. Internally each wire is a shared memory object and each block reads from these objects. This enables us to update the data inside in real time. | ||
|
||
### 1. Selecting the Blocks | ||
|
||
{% include gallery id="select" %} | ||
|
||
### 2. Skeleton Structure | ||
|
||
{% include gallery id="skeleton" %} | ||
|
||
### 3. Block Internals | ||
|
||
{% include gallery id="internals" %} | ||
|
||
Simply click on each one to zoom in | ||
|
||
### 4. Download | ||
|
||
{% include gallery id="download" %} | ||
|
||
### 5. File Structure | ||
|
||
{% include gallery id="files" %} | ||
|
||
### 6. Demo | ||
|
||
Run the program after extracting the zip file using: | ||
```bash | ||
python3 main.py | ||
``` | ||
|
||
The output: | ||
|
||
{% include gallery id="demo" %} | ||
|
||
|
||
## Conclusion | ||
|
||
We have learnt how to create a basic program in Visual Circuit. We have created a Hello World example using three block that are connected to each other and share image data between themselves. | ||
|
||
In a similar fashion we can create more complicated applications with the only constrain being the data that is shared in between them. Further we can also edit the internal code of each block to make it suit our needs. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.