Skip to content
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.

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

rearrange/cleanup dronecan website , get menu working on at least home page #8

Merged
merged 1 commit into from
Dec 23, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.sass-cache/
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
23 changes: 13 additions & 10 deletions specification/GUI_Tool/Overview.md → GUI_Tool/Overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,18 @@ weight: 0
permalink: /GUI_Tool/Overview/
---

# UAVCAN GUI Tool
# DroneCAN GUI Tool

{% include lightbox.html url="/GUI_Tool/figures/screenshot.png" title="UAVCAN GUI Tool" thumbnail="true" %}
{% include lightbox.html url="/GUI_Tool/figures/screenshot.png" title="DroneCAN GUI Tool" thumbnail="true" %}

{% include lightbox.html url="/GUI_Tool/figures/demo_sin_cos_setpoint.png" title="Using the embedded IPython console" thumbnail="true" %}

{% include lightbox.html url="/GUI_Tool/figures/demo_node_configuration.png" title="Remote node reconfiguration" thumbnail="true" %}

UAVCAN GUI Tool is a cross-platform free open source application for UAVCAN bus management and diagnostics.
DroneCAN GUI Tool is a cross-platform free open source application for DroneCAN bus management and diagnostics.
It runs on Windows, Linux, and OSX.

* Real time monitoring of CAN bus and UAVCAN transfer dissection.
* Real time monitoring of CAN bus and DroneCAN transfer dissection.
* Plotting values in real time.
* Remote node reconfiguration (`uavcan.protocol.param`).
* Firmware update on remote nodes.
Expand All @@ -27,7 +27,7 @@ It runs on Windows, Linux, and OSX.

### Windows

Download and install the latest MSI package from <https://files.zubax.com/products/org.uavcan.gui_tool>.
Download and install the latest MSI package from <https://firmware.ardupilot.org/Tools/CAN_GUI/>.

### Linux

Expand All @@ -36,22 +36,25 @@ Note that if you're using a USB SLCAN adapter, it may be necessary to

#### Ubuntu, Mint, and other Debian-based distros


```bash

sudo apt-get install -y python3-pip python3-setuptools python3-wheel
sudo apt-get install -y python3-numpy python3-pyqt5 python3-pyqt5.qtsvg git-core
sudo pip3 install git+https://github.com/UAVCAN/gui_tool@master
sudo pip3 install pydronecan
sudo pip3 install git+https://github.com/DroneCAN/gui_tool@master
```

#### Other distributions

Please refer to the README file in the source repository: <https://github.com/UAVCAN/gui_tool>.
Please refer to the README file in the source repository: <https://github.com/DroneCAN/gui_tool>.

### OSX

Please refer to the README file in the source repository: <https://github.com/UAVCAN/gui_tool>.
Please refer to the README file in the source repository: <https://github.com/DroneCAN/gui_tool>.

## Feedback

Direct your questions and feedback to the [mailing list or the chat room](/Contact).
Direct your questions and feedback to the [discussion area](/Contact).

Pull requests and bug reports are welcome at the GitHub repository at <https://github.com/UAVCAN/gui_tool>.
Pull requests and bug reports are welcome at the GitHub repository at <https://github.com/DroneCAN/gui_tool>.
File renamed without changes.
File renamed without changes.
File renamed without changes.
224 changes: 224 additions & 0 deletions Gemfile.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1,224 @@
GEM
remote: https://rubygems.org/
specs:
activesupport (4.2.8)
i18n (~> 0.7)
minitest (~> 5.1)
thread_safe (~> 0.3, >= 0.3.4)
tzinfo (~> 1.1)
addressable (2.8.0)
public_suffix (>= 2.0.2, < 5.0)
coffee-script (2.4.1)
coffee-script-source
execjs
coffee-script-source (1.12.2)
colorator (1.1.0)
concurrent-ruby (1.1.9)
ethon (0.15.0)
ffi (>= 1.15.0)
execjs (2.8.1)
faraday (1.8.0)
faraday-em_http (~> 1.0)
faraday-em_synchrony (~> 1.0)
faraday-excon (~> 1.1)
faraday-httpclient (~> 1.0.1)
faraday-net_http (~> 1.0)
faraday-net_http_persistent (~> 1.1)
faraday-patron (~> 1.0)
faraday-rack (~> 1.0)
multipart-post (>= 1.2, < 3)
ruby2_keywords (>= 0.0.4)
faraday-em_http (1.0.0)
faraday-em_synchrony (1.0.0)
faraday-excon (1.1.0)
faraday-httpclient (1.0.1)
faraday-net_http (1.0.1)
faraday-net_http_persistent (1.2.0)
faraday-patron (1.0.0)
faraday-rack (1.0.0)
ffi (1.15.4)
forwardable-extended (2.6.0)
gemoji (3.0.1)
github-pages (142)
activesupport (= 4.2.8)
github-pages-health-check (= 1.3.4)
jekyll (= 3.4.5)
jekyll-avatar (= 0.4.2)
jekyll-coffeescript (= 1.0.1)
jekyll-default-layout (= 0.1.4)
jekyll-feed (= 0.9.2)
jekyll-gist (= 1.4.0)
jekyll-github-metadata (= 2.4.0)
jekyll-mentions (= 1.2.0)
jekyll-optional-front-matter (= 0.1.2)
jekyll-paginate (= 1.1.0)
jekyll-readme-index (= 0.1.0)
jekyll-redirect-from (= 0.12.1)
jekyll-relative-links (= 0.4.1)
jekyll-sass-converter (= 1.5.0)
jekyll-seo-tag (= 2.2.3)
jekyll-sitemap (= 1.0.0)
jekyll-swiss (= 0.4.0)
jekyll-theme-architect (= 0.0.4)
jekyll-theme-cayman (= 0.0.4)
jekyll-theme-dinky (= 0.0.4)
jekyll-theme-hacker (= 0.0.4)
jekyll-theme-leap-day (= 0.0.4)
jekyll-theme-merlot (= 0.0.4)
jekyll-theme-midnight (= 0.0.4)
jekyll-theme-minimal (= 0.0.4)
jekyll-theme-modernist (= 0.0.4)
jekyll-theme-primer (= 0.2.1)
jekyll-theme-slate (= 0.0.4)
jekyll-theme-tactile (= 0.0.4)
jekyll-theme-time-machine (= 0.0.4)
jekyll-titles-from-headings (= 0.2.0)
jemoji (= 0.8.0)
kramdown (= 1.13.2)
liquid (= 3.0.6)
listen (= 3.0.6)
mercenary (~> 0.3)
minima (= 2.1.1)
rouge (= 1.11.1)
terminal-table (~> 1.4)
github-pages-health-check (1.3.4)
addressable (~> 2.3)
net-dns (~> 0.8)
octokit (~> 4.0)
public_suffix (~> 2.0)
typhoeus (~> 0.7)
html-pipeline (2.14.0)
activesupport (>= 2)
nokogiri (>= 1.4)
i18n (0.9.5)
concurrent-ruby (~> 1.0)
jekyll (3.4.5)
addressable (~> 2.4)
colorator (~> 1.0)
jekyll-sass-converter (~> 1.0)
jekyll-watch (~> 1.1)
kramdown (~> 1.3)
liquid (~> 3.0)
mercenary (~> 0.3.3)
pathutil (~> 0.9)
rouge (~> 1.7)
safe_yaml (~> 1.0)
jekyll-avatar (0.4.2)
jekyll (~> 3.0)
jekyll-coffeescript (1.0.1)
coffee-script (~> 2.2)
jekyll-default-layout (0.1.4)
jekyll (~> 3.0)
jekyll-feed (0.9.2)
jekyll (~> 3.3)
jekyll-gist (1.4.0)
octokit (~> 4.2)
jekyll-github-metadata (2.4.0)
jekyll (~> 3.1)
octokit (~> 4.0, != 4.4.0)
jekyll-mentions (1.2.0)
activesupport (~> 4.0)
html-pipeline (~> 2.3)
jekyll (~> 3.0)
jekyll-optional-front-matter (0.1.2)
jekyll (~> 3.0)
jekyll-paginate (1.1.0)
jekyll-readme-index (0.1.0)
jekyll (~> 3.0)
jekyll-redirect-from (0.12.1)
jekyll (~> 3.3)
jekyll-relative-links (0.4.1)
jekyll (~> 3.3)
jekyll-sass-converter (1.5.0)
sass (~> 3.4)
jekyll-seo-tag (2.2.3)
jekyll (~> 3.3)
jekyll-sitemap (1.0.0)
jekyll (~> 3.3)
jekyll-swiss (0.4.0)
jekyll-theme-architect (0.0.4)
jekyll (~> 3.3)
jekyll-theme-cayman (0.0.4)
jekyll (~> 3.3)
jekyll-theme-dinky (0.0.4)
jekyll (~> 3.3)
jekyll-theme-hacker (0.0.4)
jekyll (~> 3.3)
jekyll-theme-leap-day (0.0.4)
jekyll (~> 3.3)
jekyll-theme-merlot (0.0.4)
jekyll (~> 3.3)
jekyll-theme-midnight (0.0.4)
jekyll (~> 3.3)
jekyll-theme-minimal (0.0.4)
jekyll (~> 3.3)
jekyll-theme-modernist (0.0.4)
jekyll (~> 3.3)
jekyll-theme-primer (0.2.1)
jekyll (~> 3.3)
jekyll-theme-slate (0.0.4)
jekyll (~> 3.3)
jekyll-theme-tactile (0.0.4)
jekyll (~> 3.3)
jekyll-theme-time-machine (0.0.4)
jekyll (~> 3.3)
jekyll-titles-from-headings (0.2.0)
jekyll (~> 3.3)
jekyll-watch (1.5.1)
listen (~> 3.0)
jemoji (0.8.0)
activesupport (~> 4.0)
gemoji (~> 3.0)
html-pipeline (~> 2.2)
jekyll (>= 3.0)
kramdown (1.13.2)
liquid (3.0.6)
listen (3.0.6)
rb-fsevent (>= 0.9.3)
rb-inotify (>= 0.9.7)
mercenary (0.3.6)
minima (2.1.1)
jekyll (~> 3.3)
minitest (5.15.0)
multipart-post (2.1.1)
net-dns (0.9.0)
nokogiri (1.12.5-x86_64-linux)
racc (~> 1.4)
octokit (4.21.0)
faraday (>= 0.9)
sawyer (~> 0.8.0, >= 0.5.3)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
public_suffix (2.0.5)
racc (1.6.0)
rb-fsevent (0.11.0)
rb-inotify (0.10.1)
ffi (~> 1.0)
rouge (1.11.1)
ruby2_keywords (0.0.5)
safe_yaml (1.0.5)
sass (3.7.4)
sass-listen (~> 4.0.0)
sass-listen (4.0.0)
rb-fsevent (~> 0.9, >= 0.9.4)
rb-inotify (~> 0.9, >= 0.9.7)
sawyer (0.8.2)
addressable (>= 2.3.5)
faraday (> 0.8, < 2.0)
terminal-table (1.8.0)
unicode-display_width (~> 1.1, >= 1.1.1)
thread_safe (0.3.6)
typhoeus (0.8.0)
ethon (>= 0.8.0)
tzinfo (1.2.9)
thread_safe (~> 0.1)
unicode-display_width (1.8.0)

PLATFORMS
x86_64-linux

DEPENDENCIES
github-pages (= 142)

BUNDLED WITH
2.3.1
File renamed without changes.
48 changes: 26 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,41 @@
## Welcome to GitHub Pages
# Dronecan V1 website

You can use the [editor on GitHub](https://github.com/dronecan/dronecan.github.io/edit/master/index.md) to maintain and preview the content for your website in Markdown files.
[![Discussions](https://dronecan.org/discord)](https://dronecan.org/discord)

Whenever you commit to this repository, GitHub Pages will run [Jekyll](https://jekyllrb.com/) to rebuild the pages in your site, from the content in your Markdown files.

### Markdown
This repository contains sources of the DronCAN V1 website available at <https://dronecan.github.io>.

Markdown is a lightweight and easy-to-use syntax for styling your writing. It includes conventions for
How to configure Jekyll with Github Pages: <https://help.github.com/articles/using-jekyll-with-pages>.

```markdown
Syntax highlighted code block
## Dependencies

# Header 1
## Header 2
### Header 3
### [Ruby](https://www.ruby-lang.org/en/)

- Bulleted
- List
Install Ruby 2.x. If necessary, activate it using [RVM](https://rvm.io/).

1. Numbered
2. List
### [Bundler](http://bundler.io/)

**Bold** and _Italic_ and `Code` text
Follow the instructions on the [repository page](https://github.com/bundler/bundler) to install Bundler.

[Link](url) and ![Image](src)
```
### [Jekyll](http://jekyllrb.com/)

Enter your local clone derictory (make sure you have Gemfile there). Execute from the terminal: `bundle install`.

## Running the website locally

For more details see [GitHub Flavored Markdown](https://guides.github.com/features/mastering-markdown/).
1. Enter your local clone derictory (where the Gemfile is located).
Make sure that all git submodules are initialized by running `git submodule update --init --recursive`.
2. Execute from the terminal `bundle exec jekyll serve` and wait until the page is generated.
3. Open your internet browser and navigate to <http://localhost:4000> to see your local website.

### Jekyll Themes
## Troubleshooting

Your Pages site will use the layout and styles from the Jekyll theme you have selected in your [repository settings](https://github.com/dronecan/dronecan.github.io/settings). The name of this theme is saved in the Jekyll `_config.yml` configuration file.
In case you have an error like `in 'autodetect': Could not find a JavaScript runtime.`
while running `bundle exec jekyll serve`, add the following lines to the `Gemfile` in the parent folder:

### Support or Contact
```
gem 'execjs'
gem 'therubyracer'
```

Having trouble with Pages? Check out our [documentation](https://help.github.com/categories/github-pages-basics/) or [contact support](https://github.com/contact) and we’ll help you sort it out.
Then open the terminal and run `bundle update && bundle install`.
Loading