This repository was archived by the owner on Oct 8, 2021. It is now read-only.

Latest commit

History

460 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

NRMC2019

Repository for the Bison Robotics NASA Robotic Mining Competition 2019 Entry

Build status: Build Status

Development Conventions

GitHub

Every card on the sprint board should be tied to an issue. Any issue X that involves code development should have a corresponding branch named issue-X. In order to merge into master a pull request has to be initiated and approved by one other developer. Generally a request shouldn't be merged if it doesn't have tests, it's tests aren't passing, or the Travis-CI build fails. Once the pull request is merged, the corresponding issue should be closed, and the branch corresponding to the request should be deleted. Deleting the branch will appear as a prompt on merge. A good way to automatically close the issue is to reference the issue using a keyword. For example I could reference issue 1 in my pull request by adding the text "closes #1". Try to update the project board when starting, reviewing, and finishing tasks.

Style Guidelines

ROS

See: http://wiki.ros.org/ROS/Patterns/Conventions
And: http://wiki.ros.org/StyleGuide

C++

See: http://wiki.ros.org/CppStyleGuide
And: https://google.github.io/styleguide/cppguide.html

Python

See: http://wiki.ros.org/PyStyleGuide

Unit Testing

See: http://wiki.ros.org/Quality/Tutorials/UnitTesting

Getting Started

Setup your ssh keys

Follow these instructions: https://help.github.com/articles/connecting-to-github-with-ssh/

Clone the repo

There are certain scripts that assume that you have the NRMC2019 repo installed in your home directory. It is recommended you don't try to clone the repo anywhere else.

cd ~
git clone git@github.com:BisonRobotics/NRMC2019.git

Configure your OS

Much of the setup process was automated last year. Assuming you are running Ubuntu 16.04, you should be able to just run the following lines of code.

# Install ansible, restart your computer afterwards
sudo apt update
sudo apt install ansible
# Install dependencies
cd ~/NRMC2019
ansible-playbook -i "localhost," -c local src/utilities/ansible/dev_computer_playbook.yml
git lfs install
git lfs pull
# Build NRMC2019 and setup workspace
catkin_make
source devel/setup.bash
# Run unit tests
catkin_make run_tests

If this process doesn't work for you, the manual process is described here

Setup an IDE

I highly recommend using the clion IDE available at https://www.jetbrains.com/clion/. Make sure you sign up for an education account so you don't have to pay for it. Otherwise if you're as hardcore as Dr. Ding, VIM works too.

In order for clion to see the libraries available to ROS, you'll need to source your ROS install setup.bash and ROS workspace setup.bash (after a build) before launching clion from the same terminal

Setup Workspace

Our workspace is the NRM2019 repository this README lives in. You can add some optional aliases that make launching stuff and working with ROS easier

echo "alias clion='~/clion/bin/clion.sh'" >> ~/.bashrc
echo "alias ws='cd ~/NRMC2019'" >> ~/.bashrc
echo "alias wss='source ~/NRMC2019/devel/setup.bash'" >> ~/.bashrc

Permissions issue

If you are having a permissions issue with git follow these instructions

Understand how ROS works

Do the beginner tutorials: http://wiki.ros.org/ROS/Tutorials.

Useful unit test commands for debugging

Build and run single test suite

Tab complete is your friend here

catkin_make run_tests_wheel_control_gtest_test_WaypointControllerHelper2
# Build test for debugging catkin_make -DCMAKE_BUILD_TYPE=Debug test_WaypointControllerHelper2

Debug unit tests

gdb ./devel/lib/wheel_control/test_WaypointControllerHelper2

Known Issues/Bugs in "Not-Our-Stuff"

CANables

You may not be able to enumerate two CANables on the same computer easily and as you would imagine. There is a bug in the CANable firmware which makes one CANable enumerate as two. So, to work around this issue: make one of them can1 and the other can2. Forget about can0. Less than nothing, it decieved you, and so should be scorned.

sudo ip link set can1 type can bitrate 500000 triple-sampling on
sudo ip link set can1 up
sudo ip link set can2 type can bitrate 500000 triple-sampling on
sudo ip link set can2 up

Speeding up compilation

# Disable compilation of GUIs and simulation
export ON_ROBOT=1 # Disable message generation for languages other than cpp
export ROS_LANG_DISABLE=geneus:genlisp:gennodejs:genpy

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

10 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
This repository was archived by the owner on Oct 8, 2021. It is now read-only.

Latest commit

History

460 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

NRMC2019

Repository for the Bison Robotics NASA Robotic Mining Competition 2019 Entry

Build status: Build Status

Development Conventions

GitHub

Every card on the sprint board should be tied to an issue. Any issue X that involves code development should have a corresponding branch named issue-X. In order to merge into master a pull request has to be initiated and approved by one other developer. Generally a request shouldn't be merged if it doesn't have tests, it's tests aren't passing, or the Travis-CI build fails. Once the pull request is merged, the corresponding issue should be closed, and the branch corresponding to the request should be deleted. Deleting the branch will appear as a prompt on merge. A good way to automatically close the issue is to reference the issue using a keyword. For example I could reference issue 1 in my pull request by adding the text "closes #1". Try to update the project board when starting, reviewing, and finishing tasks.

Style Guidelines

ROS

See: http://wiki.ros.org/ROS/Patterns/Conventions
And: http://wiki.ros.org/StyleGuide

C++

See: http://wiki.ros.org/CppStyleGuide
And: https://google.github.io/styleguide/cppguide.html

Python

See: http://wiki.ros.org/PyStyleGuide

Unit Testing

See: http://wiki.ros.org/Quality/Tutorials/UnitTesting

Getting Started

Setup your ssh keys

Follow these instructions: https://help.github.com/articles/connecting-to-github-with-ssh/

Clone the repo

There are certain scripts that assume that you have the NRMC2019 repo installed in your home directory. It is recommended you don't try to clone the repo anywhere else.

cd ~
git clone git@github.com:BisonRobotics/NRMC2019.git

Configure your OS

Much of the setup process was automated last year. Assuming you are running Ubuntu 16.04, you should be able to just run the following lines of code.

# Install ansible, restart your computer afterwards
sudo apt update
sudo apt install ansible
# Install dependencies
cd ~/NRMC2019
ansible-playbook -i "localhost," -c local src/utilities/ansible/dev_computer_playbook.yml
git lfs install
git lfs pull
# Build NRMC2019 and setup workspace
catkin_make
source devel/setup.bash
# Run unit tests
catkin_make run_tests

If this process doesn't work for you, the manual process is described here

Setup an IDE

I highly recommend using the clion IDE available at https://www.jetbrains.com/clion/. Make sure you sign up for an education account so you don't have to pay for it. Otherwise if you're as hardcore as Dr. Ding, VIM works too.

In order for clion to see the libraries available to ROS, you'll need to source your ROS install setup.bash and ROS workspace setup.bash (after a build) before launching clion from the same terminal

Setup Workspace

Our workspace is the NRM2019 repository this README lives in. You can add some optional aliases that make launching stuff and working with ROS easier

echo "alias clion='~/clion/bin/clion.sh'" >> ~/.bashrc
echo "alias ws='cd ~/NRMC2019'" >> ~/.bashrc
echo "alias wss='source ~/NRMC2019/devel/setup.bash'" >> ~/.bashrc

Permissions issue

If you are having a permissions issue with git follow these instructions

Understand how ROS works

Do the beginner tutorials: http://wiki.ros.org/ROS/Tutorials.

Useful unit test commands for debugging

Build and run single test suite

Tab complete is your friend here

catkin_make run_tests_wheel_control_gtest_test_WaypointControllerHelper2
# Build test for debugging catkin_make -DCMAKE_BUILD_TYPE=Debug test_WaypointControllerHelper2

Debug unit tests

gdb ./devel/lib/wheel_control/test_WaypointControllerHelper2

Known Issues/Bugs in "Not-Our-Stuff"

CANables

You may not be able to enumerate two CANables on the same computer easily and as you would imagine. There is a bug in the CANable firmware which makes one CANable enumerate as two. So, to work around this issue: make one of them can1 and the other can2. Forget about can0. Less than nothing, it decieved you, and so should be scorned.

sudo ip link set can1 type can bitrate 500000 triple-sampling on
sudo ip link set can1 up
sudo ip link set can2 type can bitrate 500000 triple-sampling on
sudo ip link set can2 up

Speeding up compilation

# Disable compilation of GUIs and simulation
export ON_ROBOT=1 # Disable message generation for languages other than cpp
export ROS_LANG_DISABLE=geneus:genlisp:gennodejs:genpy

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

10 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
This repository was archived by the owner on Oct 8, 2021. It is now read-only.

Latest commit

History

460 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

NRMC2019

Repository for the Bison Robotics NASA Robotic Mining Competition 2019 Entry

Build status: Build Status

Development Conventions

GitHub

Every card on the sprint board should be tied to an issue. Any issue X that involves code development should have a corresponding branch named issue-X. In order to merge into master a pull request has to be initiated and approved by one other developer. Generally a request shouldn't be merged if it doesn't have tests, it's tests aren't passing, or the Travis-CI build fails. Once the pull request is merged, the corresponding issue should be closed, and the branch corresponding to the request should be deleted. Deleting the branch will appear as a prompt on merge. A good way to automatically close the issue is to reference the issue using a keyword. For example I could reference issue 1 in my pull request by adding the text "closes #1". Try to update the project board when starting, reviewing, and finishing tasks.

Style Guidelines

ROS

See: http://wiki.ros.org/ROS/Patterns/Conventions
And: http://wiki.ros.org/StyleGuide

C++

See: http://wiki.ros.org/CppStyleGuide
And: https://google.github.io/styleguide/cppguide.html

Python

See: http://wiki.ros.org/PyStyleGuide

Unit Testing

See: http://wiki.ros.org/Quality/Tutorials/UnitTesting

Getting Started

Setup your ssh keys

Follow these instructions: https://help.github.com/articles/connecting-to-github-with-ssh/

Clone the repo

There are certain scripts that assume that you have the NRMC2019 repo installed in your home directory. It is recommended you don't try to clone the repo anywhere else.

cd ~
git clone git@github.com:BisonRobotics/NRMC2019.git

Configure your OS

Much of the setup process was automated last year. Assuming you are running Ubuntu 16.04, you should be able to just run the following lines of code.

# Install ansible, restart your computer afterwards
sudo apt update
sudo apt install ansible
# Install dependencies
cd ~/NRMC2019
ansible-playbook -i "localhost," -c local src/utilities/ansible/dev_computer_playbook.yml
git lfs install
git lfs pull
# Build NRMC2019 and setup workspace
catkin_make
source devel/setup.bash
# Run unit tests
catkin_make run_tests

If this process doesn't work for you, the manual process is described here

Setup an IDE

I highly recommend using the clion IDE available at https://www.jetbrains.com/clion/. Make sure you sign up for an education account so you don't have to pay for it. Otherwise if you're as hardcore as Dr. Ding, VIM works too.

In order for clion to see the libraries available to ROS, you'll need to source your ROS install setup.bash and ROS workspace setup.bash (after a build) before launching clion from the same terminal

Setup Workspace

Our workspace is the NRM2019 repository this README lives in. You can add some optional aliases that make launching stuff and working with ROS easier

echo "alias clion='~/clion/bin/clion.sh'" >> ~/.bashrc
echo "alias ws='cd ~/NRMC2019'" >> ~/.bashrc
echo "alias wss='source ~/NRMC2019/devel/setup.bash'" >> ~/.bashrc

Permissions issue

If you are having a permissions issue with git follow these instructions

Understand how ROS works

Do the beginner tutorials: http://wiki.ros.org/ROS/Tutorials.

Useful unit test commands for debugging

Build and run single test suite

Tab complete is your friend here

catkin_make run_tests_wheel_control_gtest_test_WaypointControllerHelper2
# Build test for debugging catkin_make -DCMAKE_BUILD_TYPE=Debug test_WaypointControllerHelper2

Debug unit tests

gdb ./devel/lib/wheel_control/test_WaypointControllerHelper2

Known Issues/Bugs in "Not-Our-Stuff"

CANables

You may not be able to enumerate two CANables on the same computer easily and as you would imagine. There is a bug in the CANable firmware which makes one CANable enumerate as two. So, to work around this issue: make one of them can1 and the other can2. Forget about can0. Less than nothing, it decieved you, and so should be scorned.

sudo ip link set can1 type can bitrate 500000 triple-sampling on
sudo ip link set can1 up
sudo ip link set can2 type can bitrate 500000 triple-sampling on
sudo ip link set can2 up

Speeding up compilation

# Disable compilation of GUIs and simulation
export ON_ROBOT=1 # Disable message generation for languages other than cpp
export ROS_LANG_DISABLE=geneus:genlisp:gennodejs:genpy

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

10 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
This repository was archived by the owner on Oct 8, 2021. It is now read-only.

Latest commit

History

460 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

NRMC2019

Repository for the Bison Robotics NASA Robotic Mining Competition 2019 Entry

Build status: Build Status

Development Conventions

GitHub

Every card on the sprint board should be tied to an issue. Any issue X that involves code development should have a corresponding branch named issue-X. In order to merge into master a pull request has to be initiated and approved by one other developer. Generally a request shouldn't be merged if it doesn't have tests, it's tests aren't passing, or the Travis-CI build fails. Once the pull request is merged, the corresponding issue should be closed, and the branch corresponding to the request should be deleted. Deleting the branch will appear as a prompt on merge. A good way to automatically close the issue is to reference the issue using a keyword. For example I could reference issue 1 in my pull request by adding the text "closes #1". Try to update the project board when starting, reviewing, and finishing tasks.

Style Guidelines

ROS

See: http://wiki.ros.org/ROS/Patterns/Conventions
And: http://wiki.ros.org/StyleGuide

C++

See: http://wiki.ros.org/CppStyleGuide
And: https://google.github.io/styleguide/cppguide.html

Python

See: http://wiki.ros.org/PyStyleGuide

Unit Testing

See: http://wiki.ros.org/Quality/Tutorials/UnitTesting

Getting Started

Setup your ssh keys

Follow these instructions: https://help.github.com/articles/connecting-to-github-with-ssh/

Clone the repo

There are certain scripts that assume that you have the NRMC2019 repo installed in your home directory. It is recommended you don't try to clone the repo anywhere else.

cd ~
git clone git@github.com:BisonRobotics/NRMC2019.git

Configure your OS

Much of the setup process was automated last year. Assuming you are running Ubuntu 16.04, you should be able to just run the following lines of code.

# Install ansible, restart your computer afterwards
sudo apt update
sudo apt install ansible
# Install dependencies
cd ~/NRMC2019
ansible-playbook -i "localhost," -c local src/utilities/ansible/dev_computer_playbook.yml
git lfs install
git lfs pull
# Build NRMC2019 and setup workspace
catkin_make
source devel/setup.bash
# Run unit tests
catkin_make run_tests

If this process doesn't work for you, the manual process is described here

Setup an IDE

I highly recommend using the clion IDE available at https://www.jetbrains.com/clion/. Make sure you sign up for an education account so you don't have to pay for it. Otherwise if you're as hardcore as Dr. Ding, VIM works too.

In order for clion to see the libraries available to ROS, you'll need to source your ROS install setup.bash and ROS workspace setup.bash (after a build) before launching clion from the same terminal

Setup Workspace

Our workspace is the NRM2019 repository this README lives in. You can add some optional aliases that make launching stuff and working with ROS easier

echo "alias clion='~/clion/bin/clion.sh'" >> ~/.bashrc
echo "alias ws='cd ~/NRMC2019'" >> ~/.bashrc
echo "alias wss='source ~/NRMC2019/devel/setup.bash'" >> ~/.bashrc

Permissions issue

If you are having a permissions issue with git follow these instructions

Understand how ROS works

Do the beginner tutorials: http://wiki.ros.org/ROS/Tutorials.

Useful unit test commands for debugging

Build and run single test suite

Tab complete is your friend here

catkin_make run_tests_wheel_control_gtest_test_WaypointControllerHelper2
# Build test for debugging catkin_make -DCMAKE_BUILD_TYPE=Debug test_WaypointControllerHelper2

Debug unit tests

gdb ./devel/lib/wheel_control/test_WaypointControllerHelper2

Known Issues/Bugs in "Not-Our-Stuff"

CANables

You may not be able to enumerate two CANables on the same computer easily and as you would imagine. There is a bug in the CANable firmware which makes one CANable enumerate as two. So, to work around this issue: make one of them can1 and the other can2. Forget about can0. Less than nothing, it decieved you, and so should be scorned.

sudo ip link set can1 type can bitrate 500000 triple-sampling on
sudo ip link set can1 up
sudo ip link set can2 type can bitrate 500000 triple-sampling on
sudo ip link set can2 up

Speeding up compilation

# Disable compilation of GUIs and simulation
export ON_ROBOT=1 # Disable message generation for languages other than cpp
export ROS_LANG_DISABLE=geneus:genlisp:gennodejs:genpy

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

10 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
This repository was archived by the owner on Oct 8, 2021. It is now read-only.

Latest commit

History

460 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

NRMC2019

Repository for the Bison Robotics NASA Robotic Mining Competition 2019 Entry

Build status: Build Status

Development Conventions

GitHub

Every card on the sprint board should be tied to an issue. Any issue X that involves code development should have a corresponding branch named issue-X. In order to merge into master a pull request has to be initiated and approved by one other developer. Generally a request shouldn't be merged if it doesn't have tests, it's tests aren't passing, or the Travis-CI build fails. Once the pull request is merged, the corresponding issue should be closed, and the branch corresponding to the request should be deleted. Deleting the branch will appear as a prompt on merge. A good way to automatically close the issue is to reference the issue using a keyword. For example I could reference issue 1 in my pull request by adding the text "closes #1". Try to update the project board when starting, reviewing, and finishing tasks.

Style Guidelines

ROS

See: http://wiki.ros.org/ROS/Patterns/Conventions
And: http://wiki.ros.org/StyleGuide

C++

See: http://wiki.ros.org/CppStyleGuide
And: https://google.github.io/styleguide/cppguide.html

Python

See: http://wiki.ros.org/PyStyleGuide

Unit Testing

See: http://wiki.ros.org/Quality/Tutorials/UnitTesting

Getting Started

Setup your ssh keys

Follow these instructions: https://help.github.com/articles/connecting-to-github-with-ssh/

Clone the repo

There are certain scripts that assume that you have the NRMC2019 repo installed in your home directory. It is recommended you don't try to clone the repo anywhere else.

cd ~
git clone git@github.com:BisonRobotics/NRMC2019.git

Configure your OS

Much of the setup process was automated last year. Assuming you are running Ubuntu 16.04, you should be able to just run the following lines of code.

# Install ansible, restart your computer afterwards
sudo apt update
sudo apt install ansible
# Install dependencies
cd ~/NRMC2019
ansible-playbook -i "localhost," -c local src/utilities/ansible/dev_computer_playbook.yml
git lfs install
git lfs pull
# Build NRMC2019 and setup workspace
catkin_make
source devel/setup.bash
# Run unit tests
catkin_make run_tests

If this process doesn't work for you, the manual process is described here

Setup an IDE

I highly recommend using the clion IDE available at https://www.jetbrains.com/clion/. Make sure you sign up for an education account so you don't have to pay for it. Otherwise if you're as hardcore as Dr. Ding, VIM works too.

In order for clion to see the libraries available to ROS, you'll need to source your ROS install setup.bash and ROS workspace setup.bash (after a build) before launching clion from the same terminal

Setup Workspace

Our workspace is the NRM2019 repository this README lives in. You can add some optional aliases that make launching stuff and working with ROS easier

echo "alias clion='~/clion/bin/clion.sh'" >> ~/.bashrc
echo "alias ws='cd ~/NRMC2019'" >> ~/.bashrc
echo "alias wss='source ~/NRMC2019/devel/setup.bash'" >> ~/.bashrc

Permissions issue

If you are having a permissions issue with git follow these instructions

Understand how ROS works

Do the beginner tutorials: http://wiki.ros.org/ROS/Tutorials.

Useful unit test commands for debugging

Build and run single test suite

Tab complete is your friend here

catkin_make run_tests_wheel_control_gtest_test_WaypointControllerHelper2
# Build test for debugging catkin_make -DCMAKE_BUILD_TYPE=Debug test_WaypointControllerHelper2

Debug unit tests

gdb ./devel/lib/wheel_control/test_WaypointControllerHelper2

Known Issues/Bugs in "Not-Our-Stuff"

CANables

You may not be able to enumerate two CANables on the same computer easily and as you would imagine. There is a bug in the CANable firmware which makes one CANable enumerate as two. So, to work around this issue: make one of them can1 and the other can2. Forget about can0. Less than nothing, it decieved you, and so should be scorned.

sudo ip link set can1 type can bitrate 500000 triple-sampling on
sudo ip link set can1 up
sudo ip link set can2 type can bitrate 500000 triple-sampling on
sudo ip link set can2 up

Speeding up compilation

# Disable compilation of GUIs and simulation
export ON_ROBOT=1 # Disable message generation for languages other than cpp
export ROS_LANG_DISABLE=geneus:genlisp:gennodejs:genpy

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

10 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
This repository was archived by the owner on Oct 8, 2021. It is now read-only.

Latest commit

History

460 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

NRMC2019

Repository for the Bison Robotics NASA Robotic Mining Competition 2019 Entry

Build status: Build Status

Development Conventions

GitHub

Every card on the sprint board should be tied to an issue. Any issue X that involves code development should have a corresponding branch named issue-X. In order to merge into master a pull request has to be initiated and approved by one other developer. Generally a request shouldn't be merged if it doesn't have tests, it's tests aren't passing, or the Travis-CI build fails. Once the pull request is merged, the corresponding issue should be closed, and the branch corresponding to the request should be deleted. Deleting the branch will appear as a prompt on merge. A good way to automatically close the issue is to reference the issue using a keyword. For example I could reference issue 1 in my pull request by adding the text "closes #1". Try to update the project board when starting, reviewing, and finishing tasks.

Style Guidelines

ROS

See: http://wiki.ros.org/ROS/Patterns/Conventions
And: http://wiki.ros.org/StyleGuide

C++

See: http://wiki.ros.org/CppStyleGuide
And: https://google.github.io/styleguide/cppguide.html

Python

See: http://wiki.ros.org/PyStyleGuide

Unit Testing

See: http://wiki.ros.org/Quality/Tutorials/UnitTesting

Getting Started

Setup your ssh keys

Follow these instructions: https://help.github.com/articles/connecting-to-github-with-ssh/

Clone the repo

There are certain scripts that assume that you have the NRMC2019 repo installed in your home directory. It is recommended you don't try to clone the repo anywhere else.

cd ~
git clone git@github.com:BisonRobotics/NRMC2019.git

Configure your OS

Much of the setup process was automated last year. Assuming you are running Ubuntu 16.04, you should be able to just run the following lines of code.

# Install ansible, restart your computer afterwards
sudo apt update
sudo apt install ansible
# Install dependencies
cd ~/NRMC2019
ansible-playbook -i "localhost," -c local src/utilities/ansible/dev_computer_playbook.yml
git lfs install
git lfs pull
# Build NRMC2019 and setup workspace
catkin_make
source devel/setup.bash
# Run unit tests
catkin_make run_tests

If this process doesn't work for you, the manual process is described here

Setup an IDE

I highly recommend using the clion IDE available at https://www.jetbrains.com/clion/. Make sure you sign up for an education account so you don't have to pay for it. Otherwise if you're as hardcore as Dr. Ding, VIM works too.

In order for clion to see the libraries available to ROS, you'll need to source your ROS install setup.bash and ROS workspace setup.bash (after a build) before launching clion from the same terminal

Setup Workspace

Our workspace is the NRM2019 repository this README lives in. You can add some optional aliases that make launching stuff and working with ROS easier

echo "alias clion='~/clion/bin/clion.sh'" >> ~/.bashrc
echo "alias ws='cd ~/NRMC2019'" >> ~/.bashrc
echo "alias wss='source ~/NRMC2019/devel/setup.bash'" >> ~/.bashrc

Permissions issue

If you are having a permissions issue with git follow these instructions

Understand how ROS works

Do the beginner tutorials: http://wiki.ros.org/ROS/Tutorials.

Useful unit test commands for debugging

Build and run single test suite

Tab complete is your friend here

catkin_make run_tests_wheel_control_gtest_test_WaypointControllerHelper2
# Build test for debugging catkin_make -DCMAKE_BUILD_TYPE=Debug test_WaypointControllerHelper2

Debug unit tests

gdb ./devel/lib/wheel_control/test_WaypointControllerHelper2

Known Issues/Bugs in "Not-Our-Stuff"

CANables

You may not be able to enumerate two CANables on the same computer easily and as you would imagine. There is a bug in the CANable firmware which makes one CANable enumerate as two. So, to work around this issue: make one of them can1 and the other can2. Forget about can0. Less than nothing, it decieved you, and so should be scorned.

sudo ip link set can1 type can bitrate 500000 triple-sampling on
sudo ip link set can1 up
sudo ip link set can2 type can bitrate 500000 triple-sampling on
sudo ip link set can2 up

Speeding up compilation

# Disable compilation of GUIs and simulation
export ON_ROBOT=1 # Disable message generation for languages other than cpp
export ROS_LANG_DISABLE=geneus:genlisp:gennodejs:genpy

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

10 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
This repository was archived by the owner on Oct 8, 2021. It is now read-only.

Latest commit

History

460 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

NRMC2019

Repository for the Bison Robotics NASA Robotic Mining Competition 2019 Entry

Build status: Build Status

Development Conventions

GitHub

Every card on the sprint board should be tied to an issue. Any issue X that involves code development should have a corresponding branch named issue-X. In order to merge into master a pull request has to be initiated and approved by one other developer. Generally a request shouldn't be merged if it doesn't have tests, it's tests aren't passing, or the Travis-CI build fails. Once the pull request is merged, the corresponding issue should be closed, and the branch corresponding to the request should be deleted. Deleting the branch will appear as a prompt on merge. A good way to automatically close the issue is to reference the issue using a keyword. For example I could reference issue 1 in my pull request by adding the text "closes #1". Try to update the project board when starting, reviewing, and finishing tasks.

Style Guidelines

ROS

See: http://wiki.ros.org/ROS/Patterns/Conventions
And: http://wiki.ros.org/StyleGuide

C++

See: http://wiki.ros.org/CppStyleGuide
And: https://google.github.io/styleguide/cppguide.html

Python

See: http://wiki.ros.org/PyStyleGuide

Unit Testing

See: http://wiki.ros.org/Quality/Tutorials/UnitTesting

Getting Started

Setup your ssh keys

Follow these instructions: https://help.github.com/articles/connecting-to-github-with-ssh/

Clone the repo

There are certain scripts that assume that you have the NRMC2019 repo installed in your home directory. It is recommended you don't try to clone the repo anywhere else.

cd ~
git clone git@github.com:BisonRobotics/NRMC2019.git

Configure your OS

Much of the setup process was automated last year. Assuming you are running Ubuntu 16.04, you should be able to just run the following lines of code.

# Install ansible, restart your computer afterwards
sudo apt update
sudo apt install ansible
# Install dependencies
cd ~/NRMC2019
ansible-playbook -i "localhost," -c local src/utilities/ansible/dev_computer_playbook.yml
git lfs install
git lfs pull
# Build NRMC2019 and setup workspace
catkin_make
source devel/setup.bash
# Run unit tests
catkin_make run_tests

If this process doesn't work for you, the manual process is described here

Setup an IDE

I highly recommend using the clion IDE available at https://www.jetbrains.com/clion/. Make sure you sign up for an education account so you don't have to pay for it. Otherwise if you're as hardcore as Dr. Ding, VIM works too.

In order for clion to see the libraries available to ROS, you'll need to source your ROS install setup.bash and ROS workspace setup.bash (after a build) before launching clion from the same terminal

Setup Workspace

Our workspace is the NRM2019 repository this README lives in. You can add some optional aliases that make launching stuff and working with ROS easier

echo "alias clion='~/clion/bin/clion.sh'" >> ~/.bashrc
echo "alias ws='cd ~/NRMC2019'" >> ~/.bashrc
echo "alias wss='source ~/NRMC2019/devel/setup.bash'" >> ~/.bashrc

Permissions issue

If you are having a permissions issue with git follow these instructions

Understand how ROS works

Do the beginner tutorials: http://wiki.ros.org/ROS/Tutorials.

Useful unit test commands for debugging

Build and run single test suite

Tab complete is your friend here

catkin_make run_tests_wheel_control_gtest_test_WaypointControllerHelper2
# Build test for debugging catkin_make -DCMAKE_BUILD_TYPE=Debug test_WaypointControllerHelper2

Debug unit tests

gdb ./devel/lib/wheel_control/test_WaypointControllerHelper2

Known Issues/Bugs in "Not-Our-Stuff"

CANables

You may not be able to enumerate two CANables on the same computer easily and as you would imagine. There is a bug in the CANable firmware which makes one CANable enumerate as two. So, to work around this issue: make one of them can1 and the other can2. Forget about can0. Less than nothing, it decieved you, and so should be scorned.

sudo ip link set can1 type can bitrate 500000 triple-sampling on
sudo ip link set can1 up
sudo ip link set can2 type can bitrate 500000 triple-sampling on
sudo ip link set can2 up

Speeding up compilation

# Disable compilation of GUIs and simulation
export ON_ROBOT=1 # Disable message generation for languages other than cpp
export ROS_LANG_DISABLE=geneus:genlisp:gennodejs:genpy

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

10 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
This repository was archived by the owner on Oct 8, 2021. It is now read-only.

Latest commit

History

460 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

NRMC2019

Repository for the Bison Robotics NASA Robotic Mining Competition 2019 Entry

Build status: Build Status

Development Conventions

GitHub

Every card on the sprint board should be tied to an issue. Any issue X that involves code development should have a corresponding branch named issue-X. In order to merge into master a pull request has to be initiated and approved by one other developer. Generally a request shouldn't be merged if it doesn't have tests, it's tests aren't passing, or the Travis-CI build fails. Once the pull request is merged, the corresponding issue should be closed, and the branch corresponding to the request should be deleted. Deleting the branch will appear as a prompt on merge. A good way to automatically close the issue is to reference the issue using a keyword. For example I could reference issue 1 in my pull request by adding the text "closes #1". Try to update the project board when starting, reviewing, and finishing tasks.

Style Guidelines

ROS

See: http://wiki.ros.org/ROS/Patterns/Conventions
And: http://wiki.ros.org/StyleGuide

C++

See: http://wiki.ros.org/CppStyleGuide
And: https://google.github.io/styleguide/cppguide.html

Python

See: http://wiki.ros.org/PyStyleGuide

Unit Testing

See: http://wiki.ros.org/Quality/Tutorials/UnitTesting

Getting Started

Setup your ssh keys

Follow these instructions: https://help.github.com/articles/connecting-to-github-with-ssh/

Clone the repo

There are certain scripts that assume that you have the NRMC2019 repo installed in your home directory. It is recommended you don't try to clone the repo anywhere else.

cd ~
git clone git@github.com:BisonRobotics/NRMC2019.git

Configure your OS

Much of the setup process was automated last year. Assuming you are running Ubuntu 16.04, you should be able to just run the following lines of code.

# Install ansible, restart your computer afterwards
sudo apt update
sudo apt install ansible
# Install dependencies
cd ~/NRMC2019
ansible-playbook -i "localhost," -c local src/utilities/ansible/dev_computer_playbook.yml
git lfs install
git lfs pull
# Build NRMC2019 and setup workspace
catkin_make
source devel/setup.bash
# Run unit tests
catkin_make run_tests

If this process doesn't work for you, the manual process is described here

Setup an IDE

I highly recommend using the clion IDE available at https://www.jetbrains.com/clion/. Make sure you sign up for an education account so you don't have to pay for it. Otherwise if you're as hardcore as Dr. Ding, VIM works too.

In order for clion to see the libraries available to ROS, you'll need to source your ROS install setup.bash and ROS workspace setup.bash (after a build) before launching clion from the same terminal

Setup Workspace

Our workspace is the NRM2019 repository this README lives in. You can add some optional aliases that make launching stuff and working with ROS easier

echo "alias clion='~/clion/bin/clion.sh'" >> ~/.bashrc
echo "alias ws='cd ~/NRMC2019'" >> ~/.bashrc
echo "alias wss='source ~/NRMC2019/devel/setup.bash'" >> ~/.bashrc

Permissions issue

If you are having a permissions issue with git follow these instructions

Understand how ROS works

Do the beginner tutorials: http://wiki.ros.org/ROS/Tutorials.

Useful unit test commands for debugging

Build and run single test suite

Tab complete is your friend here

catkin_make run_tests_wheel_control_gtest_test_WaypointControllerHelper2
# Build test for debugging catkin_make -DCMAKE_BUILD_TYPE=Debug test_WaypointControllerHelper2

Debug unit tests

gdb ./devel/lib/wheel_control/test_WaypointControllerHelper2

Known Issues/Bugs in "Not-Our-Stuff"

CANables

You may not be able to enumerate two CANables on the same computer easily and as you would imagine. There is a bug in the CANable firmware which makes one CANable enumerate as two. So, to work around this issue: make one of them can1 and the other can2. Forget about can0. Less than nothing, it decieved you, and so should be scorned.

sudo ip link set can1 type can bitrate 500000 triple-sampling on
sudo ip link set can1 up
sudo ip link set can2 type can bitrate 500000 triple-sampling on
sudo ip link set can2 up

Speeding up compilation

# Disable compilation of GUIs and simulation
export ON_ROBOT=1 # Disable message generation for languages other than cpp
export ROS_LANG_DISABLE=geneus:genlisp:gennodejs:genpy

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

10 watching

Forks

Releases

Packages

Contributors

Languages