Skip to content

Commit 549cdf3

Browse files
committed
Add files
0 parents  commit 549cdf3

File tree

447 files changed

+47414
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

447 files changed

+47414
-0
lines changed

.DS_Store

8 KB
Binary file not shown.

LICENSE

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
BSD 2-Clause License
2+
3+
Copyright (c) 2021, dC Admin
4+
All rights reserved.
5+
6+
Redistribution and use in source and binary forms, with or without
7+
modification, are permitted provided that the following conditions are met:
8+
9+
1. Redistributions of source code must retain the above copyright notice, this
10+
list of conditions and the following disclaimer.
11+
12+
2. Redistributions in binary form must reproduce the above copyright notice,
13+
this list of conditions and the following disclaimer in the documentation
14+
and/or other materials provided with the distribution.
15+
16+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
20+
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21+
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
22+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
23+
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24+
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<p align="center"><img src="docs/img/dASH-logo.jpg" width="25%" /><br><br></p>
2+
3+
-----------------
4+
5+
## Overview
6+
**dConstruct d.ASH SDK** is a cross-platform library for autonomous robot navigation. Use the d.ASH SDK to develop applications for your own Spot from Boston Dynamics or any other robot you wish.
7+
8+
> :pushpin: For more information on the d.ASH SDK documentation, please refer to the [latest documentation release](https://dconstruct-tech.github.io/dash-sdk/).
9+
10+
## What’s included in the SDK:
11+
| What | Description |
12+
| ------- | ------- |
13+
| **[d.ASH Server](https://dconstruct-tech.github.io/dash-sdk/#dash-server)** | The d.ASH server acts as the main server responsible for sending control commands to the robot. At the same time, the d.ASH server also broadcasts secured data to any given remote systems.|
14+
| **[d.ASH Autonomy Engine](https://dconstruct-tech.github.io/dash-sdk/#ros-driver)** | The d.ASH Autonomy Engine is the autonomy backend code that runs on the edge of the robot. It empowers the robot with robust multi-terrain (indoor and outdoor) autonomous navigation capabilities. It handles secure communication between automony engine and the remote autonomy controller. |
15+
| **[d.ASH Autonomy Controller](https://dconstruct-tech.github.io/dash-sdk/#dash-autonomy-controller)** | The d.ASH autonomy controller is the GUI (graphical user interface) for the d.ASH autonomy engine. It enable users to monitor and have full remote control of autonomy by allowing users to plot waypoints and activate autonomy on a fleet of robots. Stream real-time data via a secure connection between robots and the controller using 4G or 5G. |
16+
17+
## License
18+
This project is licensed under the [BSD 2-Clause License](LICENSE).
19+
Copyright 2021 dConstruct Technologies Pte Ltd.

_config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
theme: jekyll-theme-cayman

docs/.DS_Store

8 KB
Binary file not shown.

docs/_config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
theme: jekyll-theme-cayman

docs/dash-auto/UE-client.md

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
# d.ASH Autonomy Controller
2+
3+
As mentioned previously, the d.ASH autonomy controller is the GUI (graphical user interface) for the d.ASH SDK. It encompasses the interactive visual components for d.ASH's software and displays different elements for users to interact with to control your robot. This section of the d.ASH SDK documentation provides details about setting up the d.ASH autonomy controller, including information on its respective components.
4+
5+
---
6+
### 1.1 ^^Main Components^^
7+
8+
<!-- ![Screenshot](img/main.png){: style="width:400px"} -->
9+
10+
| Component | Description |
11+
| ------- | ------- |
12+
| ![Placeholder](img/main.png){ align=left style="width:500px"} | <br> <font size="3"> (1) ^^Main toolbar^^: Used to open other menus. <br><br> (2) ^^Slider^^: Used to move floor grid up and down. <br><br> 3) ^^Access mode^^: Used switch to mouse/keyboard mode. <br> (3) (a) ^^Navigation^^: The default mode uses the keys `WASD` to move camera and right click the mouse to zoom/tilt the camera. <br> (3) (b) ^^Waypoint creation^^: Used for adding waypoints to routes. <br><br> (4) ^^Floor grid^^ |
13+
14+
---
15+
16+
### 1.2 ^^Login^^
17+
18+
| Component | Description |
19+
| ------- | ------- |
20+
| ![Screenshot](img/login.png#center){ align=left style="width:500px"}| <br> <font size="3"> The login icon allow dConstruct users to log into the d.ASH autonomy controller using their cloud admin credentials. |
21+
22+
---
23+
24+
### 1.3 ^^Robot Connection^^
25+
26+
The robot connection icon allow users to connect/disconnect their respective robots to the d.ASH autonomy controller.
27+
28+
| Component | Description |
29+
| ------- | ------- |
30+
| ![Screenshot](img/robot-connect.png#center){ align=left style="width:500px"}| <font size="3"> (1) ^^Online pannel^^: Select from a list of robots that are online and ready to be used to connect to. <br><br> (2) ^^Connected pannel^^: Select from a list of robots that you have connected to in the client to manipulate. <br><br> (3) ^^Add button^^: Press to connect to the robot selected in the online list to add the robot to the connected list. <br><br> (4) ^^Minus button^^: Press to disconnect from a robot in the connected list. |
31+
| ![Screenshot](img/init.png#center){ align=left style="width:500px"}| <br> <font size="3"> When users first start the d.ASH SDK, they need to give an initial estimation of the robot's post on the map by configuring its `init pose`. <br><br> It tells the robot where its rough initial position is. To initialize `init pose`, draw the orange arrow by left clicking and drag the mouse on the floor grid.|
32+
33+
---
34+
35+
### 1.4 ^^Routes^^
36+
37+
The routes icon allow users to set routes for the robot to follow using waypoints. Add/remove waypoints to build your own custom routes.
38+
39+
#### 1.4.1 Route Controls
40+
41+
| Component | Description |
42+
| ------- | ------- |
43+
| ![Screenshot](img/routes.png#center){ align=left style="width:350px"} | <font size="3"> (1) ^^Route name pannel^^: Enter route name to add. <br><br> (2) ^^Add button^^: Click to add route of given name. <br><br> (3) ^^Route selection pannel^^: Click to select a route. <br><br> (4) ^^Minus button^^: Press to disconnect from a robot in the connected list. <br><br> (5) ^^Waypoint button^^: Click to add waypoints to selected route. <br><br> (6) ^^Load/save button^^: Load/save all routes. <br><br> (7) ^^Segment pannel^^: Use keypad +/- to increment/decrement segment number. |
44+
45+
---
46+
47+
#### 1.4.2 Setting Up Routes
48+
49+
| Component | Description |
50+
| ------- | ------- |
51+
| ![Screenshot](img/waypoint-1.png#center){ align=left style="width:800px"} | <font size="3"> To make a selected robot follow a selected route, add waypoints by clicking on the grid. Use `WASD` and right-click on the mouse to manipulate the view. |
52+
| ![Screenshot](img/waypoint-2.png#center){ align=left style="width:500px"} <br> ![Screenshot](img/waypoint-3.png#center){: style="width:500px"} | <font size="3"> Once the waypoints have been set, exit waypoint mode by middle clicking the mouse. On the other hand, to remove a waypoint, click on the waypoint (selected waypoint change to the color orange), and press the `delete` ket to remove. |
53+
| ![Screenshot](img/waypoint-4.png#center){ align=left style="width:500px"} | <font size="3"> You can also adjust the elevation of the grid by pressing the key `ctrl` and the mouse scroll moving the floor grid in waypoint mode. A waypoint is created when you click on grid, so, to create elevated waypoints, move grid up/down and then click.|
54+
55+
---
56+
57+
### 1.5 ^^Map Settings^^
58+
59+
The map settings icon allow users to adjust highpass, lowpass, UV Scale, and UV offset settings to customise the visuals of your map.
60+
61+
| Component | Description |
62+
| ------- | ------- |
63+
| ![Screenshot](img/map.png#center){ align=left style="width:500px"} | <font size="3"> ^^Low pass slider^^: Voxels below this value is visible. Voxels in maps have elevation, and by lowering the low pass, voxels above the low pass will be cropped. |
64+
| ![Screenshot](img/map-2.png#center){ align=left style="width:500px"} | <font size="3"> Notice that the ceiling voxels have now been cropped by reducing the low pass. |
65+
66+
---
67+
68+
### 1.6 ^^Layer Visibility^^
69+
70+
| Component | Description |
71+
| ------- | ------- |
72+
| ![Screenshot](img/layer.png#center){ align=left style="width:500px"} | <font size="3"> The layer visibility icon allow users to toggle the visibility of various items on the map. |
73+
74+
---
75+
76+
### 1.7 ^^Load Scans^^
77+
78+
The load scans icon allow users to preview scans from the d.ASH Pack.
79+
80+
| Component | Description |
81+
| ------- | ------- |
82+
| ![Screenshot](img/load-scan.png#center){ align=left style="width:500px"} | <font size="3"> (1) ^^Vox downsample size pannel^^: Select your down sample size (in metres). A large value means lower quality, but faster loading. <br><br> (2) ^^Point clouds button^^: Pick loaded point clouds to toggle translucency.. |
83+
| ![Screenshot](img/load-scan-2.png#center){ align=left style="width:500px"} | <font size="3"> Load scans in translucent mode. |
84+

docs/dash-auto/img/.DS_Store

6 KB
Binary file not shown.

docs/dash-auto/img/init.png

59.3 KB
Loading

docs/dash-auto/img/layer.png

214 KB
Loading

0 commit comments

Comments
 (0)