Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
M
MicroCART
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Deploy
Releases
Model registry
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Distributed Autonomous Networked Control Lab
MicroCART
Commits
5e430fa0
Commit
5e430fa0
authored
8 years ago
by
burneykb
Browse files
Options
Downloads
Patches
Plain Diff
Updated documentation and gitignore
parent
61b986c4
No related branches found
No related tags found
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
groundStation/.gitignore
+7
-5
7 additions, 5 deletions
groundStation/.gitignore
groundStation/README.md
+15
-19
15 additions, 19 deletions
groundStation/README.md
with
22 additions
and
24 deletions
groundStation/.gitignore
+
7
−
5
View file @
5e430fa0
...
...
@@ -44,8 +44,10 @@ obj
Cli
#symlinks
getpid
monitor
setpid
setsetpoint
getsetpoint
getnodes
addnode
getoutput
setsource
getsource
getparam
setparam
This diff is collapsed.
Click to expand it.
groundStation/README.md
+
15
−
19
View file @
5e430fa0
...
...
@@ -14,12 +14,11 @@ cd into the groundstation folder.
make
run the program with sudo privledges
sudo -E
./BackEnd
./BackEnd
If you wish to change the way the backend communicates to the quad and vice versa, look at src/config.h.
This provides a list of environment variables which you can set and use for your computer or time of use.
Because the backend must be ran with sudo privledges, you will need to preserve the env. vars. with sudo rights.
Hence the "-E" flag.
## Modifying
See MODIFYING for the software architecture/organization and how to add new functionality.
...
...
@@ -32,38 +31,35 @@ socket path is writable by the user.
Once the backend is running, various CLI tools can be used to view the state of the
quad and send commands. Each of these tools is given as the first argument
to the CLI program, for example, to
monitor
the quad, use
`cli
monitor
`
. Note that
to the CLI program, for example, to
get a node output
the quad, use
`cli
getoutput
`
. Note that
the backend socket environment variable must be set to the same value as it
was for the backend. The CLI program also supports busybox-style symbolic links.
For example, if there is a symlink named
`
monitor
`
that points to the
`cli`
binary,
running the
`
monitor
`
program will effectively run
`cli
monitor
`
.
For example, if there is a symlink named
`
getoutput
`
that points to the
`cli`
binary,
running the
`
getoutput
`
program will effectively run
`cli
getoutput
`
.
The names of the binaries is subject to change.
For more in depth usage explainations, use the --help flag.
For
a list of cli commands and
more in depth usage explainations, use the --help flag.
'./Cli --help'
For help with the specific cli command you are running, use the --help flag once again.
'./Cli
setpid
--help'
'./Cli
getoutput
--help'
### Example
In one terminal or screen, run the backend:
`
UCART_SOCKET=./ucart.socket
./BackEnd`
`./BackEnd`
This will activate the quad and the backend, and the backend will be available for
connections from the frontend tools. One useful tool is the
monitor
. In another
terminal window, run
the monitor forever:
connections from the frontend tools. One useful tool is the
getnodes
. In another
terminal window, run
`
UCART_SOCKET=./ucart.socket ./cli monitor -f`
`
./Cli getnodes`
This will begin a periodic monitoring that updates 10 times per second.
or alternatively with symlinks
Finally, in a third window, export the socket path:
`./getnodes`
`export UCART_SOCKET=./ucart.socket`
and then run any other tools to modify the quad, for example modifying PID constants:
`./cli setpid --pitch -p 1.000`
This will fetch the block_id, type_id and name of every node in the current graph
You can run any number of any combination of frontend tools at the same time.
\ No newline at end of file
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment