Skip to content

Commit

Permalink
Changes to READMEs throughout project and LICENSE and DISCLAIMER file…
Browse files Browse the repository at this point in the history
…s at project root.
  • Loading branch information
Mik Cox committed Jun 14, 2018
1 parent fb82ca3 commit 757dfed
Show file tree
Hide file tree
Showing 19 changed files with 193 additions and 99 deletions.
7 changes: 6 additions & 1 deletion DISCLAIMER.txt
@@ -1 +1,6 @@
NEED TO GET WORDING FROM ORAL
By downloading, cloning, sharing, or otherwise using the contents of this repository, you confirm that you are 18 years of age or older and understand and agree to the following:
1) You are being provided these materials “as is” without warranties of any kind, neither express nor implied, including but not limited to warranties of: merchantability; fitness for any purpose; title; being error free; or, noninfringement of third party rights.
2) You use these materials voluntarily and at your own risk. You agree that neither the California Institute of Technology/Jet Propulsion Laboratory (“JPL”) nor NASA will incur under any legal theory liability any damages, including, but limited to, direct, indirect, special, or consequential damages arising out of, resulting from, or connected to the use of the materials, including but not limited to: death of or injury to any person; damage to any property; or, any economic or reputational loss.
3) You indemnify and hold harmless JPL from any and all claims, expenses, damages, and liabilities, including attorney’s fees, resulting from your use of the materials.
4) You will take all appropriate safety measures in using the materials, and you take full responsibility for other persons to whom you provide the materials doing so as well.
5) You will not for any commercial purposes reproduce, distribute, or use the materials without the prior express written permission of JPL.
21 changes: 11 additions & 10 deletions Electrical/README.MD
@@ -1,25 +1,26 @@
# JPL Open-Source Rover Project
The JPL Open-Source Rover is a fully open-source scaled version of the 6 wheel rover design that JPL uses to explore the surface of mars. The robot is designed almost entirely out of consumer off the shelf (COTS) parts.
# Electrical Subsystem
The electrical subsystem consists of the motors, motor controllers, brain, LED array for the face, battery, and other electronic components that will control the rover. See the project's main [roadmap](/images/roadmap.png) for information on when you should be building your electrical subsystem. The electrical subsystem needs to carry two major things throughout the rover: power and data.


## Power Overview Diagram
Below is a high-level diagram showing how _power_ is transferred around the rover:
![Power Diagram Overview](Latex%20Docs/Electrical%20Build%20Doc/Pictures/Electronics/power%20diagram.PNG)

## Data Overview Diagram
Below is a high-level diagram showing how _data_ is transferred around the rover:
![Data Diagram Overview](Latex%20Docs/Electrical%20Build%20Doc/Pictures/Electronics/data%20diagram.PNG)

## Disclaimer
INSERT LINK TO DISCLAMER AND STATEMENT HERE
# Disclaimer
**By downloading, cloning, or otherwise using the contents of this repository, you agree to the terms specified in the attached [DISCLAIMER.txt file](/DISCLAIMER.txt).**

# Getting Started with the Electrical build

## Folder organization
![Electrical Folders](images/elec%20folders.png)

This is the folder organization for the electrical section. This repo contains all of the electrical build docs in it, as well as folders that contain the Gerber files to get the custom PCBs designed for the project, as well as their electrical schematics if you wish to make them on a breadboard or design your own PCBs.
The image below shows the folder organization for the electrical subsystem. This folder (Electrical) contains all of the electrical build documents ([Electrical Build.pdf](Electrical\ Build.pdf) shows how to build the Electrical subsystem, [Calibration.pdf](Calibration.pdf) shows how to calibrate your motors, and [PCB Testing.pdf](PCB\ testing.pdf) shows how to verify that your custom PCBs are working as expected). It also contains folders which hold the Gerber files you can use to order the custom PCBs for the project and their corresponding electrical schematics if you wish to build them yourself on a breadboard or design your own PCBs.

## Roadmap
![Electrical Folders](images/elec%20folders.png)

![Rover build roadmap](images/elec%20roadmap.png)
## Electrical Subsystem Roadmap
The image below shows our suggested progression through the electrical build process for this project. We highly recommend starting by testing all the electronics outside of the robot, and making sure you fully understand each of the components before putting them inside the robot. By building your electrical system outside the robot first, you allow yourself to easily debug your system without the hassle of bumping into the rest of the rover or needing to access components in inconvenient locations. Once you have a fully assembled mechanical robot, you will then be able to integrate all the electronics inside and do the wire routing, etc. Next, you will test and calibrate the motors. We recommend waiting until you have a full functioning rover before you do the LED Matrix integration. The LED Matrix is not integral to the robot driving, and it takes up a significant number of GPIO pins on the Raspberry Pi which could potentially be used for other addons (sensors, communication, etc).

Here we have a proposed roadmap of how you can go through the electrical build process for this project. We highly recommend starting by testing all the electronics outside of the robot, and making sure you fully understand each of them before putting them inside the robot. Once you have a fully assembled mechanical robot you will then be able to integrate all the electronics inside, and do the wire routing etc. Afterwards you will test and calibrate the motors. We recommend waiting until you have a full functioning rover before you do the LED Matrix integration, it is not integral to the robot working and takes up a large number of GPIO pins on the Raspberry Pi, which we know some may want to use for other devices anyway.
![Rover build roadmap](images/elec%20roadmap.png)
88 changes: 87 additions & 1 deletion LICENSE.txt
@@ -1 +1,87 @@
TO BE ADDED by Eric or Mik
Copyright 2018 California Institute of Technology. Government Sponsorship Acknowledged.

Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.

"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.

2. Grant of Copyright License.

Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.

3. Grant of Patent License.

Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.

4. Redistribution.

You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:

You must give any other recipients of the Work or Derivative Works a copy of this License; and
You must cause any modified files to carry prominent notices stating that You changed the files; and
You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.

5. Submission of Contributions.

Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.

6. Trademarks.

This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty.

Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.

8. Limitation of Liability.

In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability.

While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work

To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
13 changes: 7 additions & 6 deletions Mechanical/Body Assembly/README.md
@@ -1,16 +1,17 @@
# Project Title
# Main Body
The body is the housing of all the electronics for the rover. It is the attachment points for the rocker-bogie systems, as well as the differential pivot system.

![Rover head picture](Latex%20Doc/Pictures/Body/Finished%20Body%201.PNG)

## Features
* Gives passthrough connections for USB ports on Rasberry Pi
* Gives passthrough connections for USB ports on Raspberry Pi
* Cutouts on the rear of the body give access for voltage monitor and battery for charging
* Easy attachment point for differential pivot system
* Uses actobotics parts to facilitate modularity and ability to change, and add new components easily.
* Uses Actobotics parts to facilitate modularity and ability to change, and add new components easily.

## Information about module

| Author/Creator | Eric Junkins |
| Author/Creator | JPL |
| -------------- | ------- |
| Cost without 3D printer | 240.38 |
| Cost with 3D printer | 240.38 |
Expand All @@ -23,15 +24,15 @@ The body is the housing of all the electronics for the rover. It is the attachme

## Tools

### Manditory
### Mandatory
* Band saw or Dremel
* Allen Key set
* Imperial Wrench Set

### Optional
* Laser cutter

## Dependancies on Other Modules:
## Dependencies on Other Modules:
* None

## Mechanical Interface/Attachments to Rover:
Expand Down
16 changes: 8 additions & 8 deletions Mechanical/Corner Steering/README.md
@@ -1,16 +1,16 @@
# Project Title
The Corner Steering system gives attachment points for coner motors used in Ackerman steering method of driving the rover
# Corner Steering
The Corner Steering system gives attachment points for corner motors that we use to steer the rover.

![Corner steering pic](Latex%20Docs/Pictures/CornerSt%20Step%207.PNG)

## Features
* Uses absolute encoders to track position of corners without having to recalibrate every time
* Mechanically isolates the motor from moments/loads, keeping motor gearbox safe
* 3D printed pieces to help with calibration and provide with physical limit on corner movement
* Absolute encoders track the position of corners without having to recalibrate every time the rover reboots
* Mechanically isolates the motor from moments/loads, keeping the motor gearbox more safe
* Custom 3D printed pieces help with calibration and provide a physical limit on corner movement

## Information about module

| Author/Creator | Eric Junkins |
| Author/Creator | JPL |
| -------------- | ------- |
| Cost without 3D printer | 516.14 |
| Cost with 3D printer | 464.54 |
Expand All @@ -23,7 +23,7 @@ The Corner Steering system gives attachment points for coner motors used in Acke

## Tools

### Manditory
### Mandatory
* Band saw or Dremel
* Clamps
* Allen Key set
Expand All @@ -32,7 +32,7 @@ The Corner Steering system gives attachment points for coner motors used in Acke
### Optional
* 3D printer

## Dependancies on Other Modules:
## Dependencies on Other Modules:
* None

## Mechanical Interface/Attachments to Rover:
Expand Down

0 comments on commit 757dfed

Please sign in to comment.