SCDS/FtcRobotControllerSDK
7
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

12-26-2022 restore Return-to-Top function. Header-only link is no longer recognized, now requires full URL.

Westside Robotics
2022-12-26 11:21:41 -08:00
parent e3d504c0ae
commit 0b8efcaa08
1 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
External-Libraries-in-OnBot-Java-and-Blocks.md

@ -27,7 +27,7 @@ Step 3 has three variations, depending on your planned use of the library.
**Step 3C** is a different scenario, where the library method is made available directly to the Blocks user, **without creating a myBlock**. This can be done, if the library is specially annotated by its author. **Step 3C** is a different scenario, where the library method is made available directly to the Blocks user, **without creating a myBlock**. This can be done, if the library is specially annotated by its author.
[<p align="right"><i>Return to Top</i>](#introduction)<p> <p align="right"><i>[[Return to Top|https://github.com/FIRST-Tech-Challenge/FtcRobotController/wiki/External Libraries in OnBot Java and Blocks]]</i><p>
## Step 1 - Select library, get archive file ## Step 1 - Select library, get archive file
@ -41,7 +41,7 @@ If you're having trouble locating that .jar file, or if you're not sure how to u
Then just download that .jar or .aar file to local storage such as your laptop or to a team Google drive. Then just download that .jar or .aar file to local storage such as your laptop or to a team Google drive.
[<p align="right"><i>Return to Top</i>](#introduction)<p> <p align="right"><i>[[Return to Top|https://github.com/FIRST-Tech-Challenge/FtcRobotController/wiki/External Libraries in OnBot Java and Blocks]]</i><p>
## Step 2 - Upload archive file ## Step 2 - Upload archive file
@ -61,7 +61,7 @@ OnBot Java will recognize that it's an archive file, and will automatically crea
<p align="center">[[/images/External-Libraries-in-OnBot-Java-and-Blocks/400-folder-and-wrench.png|ExternalLibraries folder and Build Everything icon]] <p align="center">[[/images/External-Libraries-in-OnBot-Java-and-Blocks/400-folder-and-wrench.png|ExternalLibraries folder and Build Everything icon]]
<br><i><b>ExternalLibraries folder and Build Everything icon</b></i><p> <br><i><b>ExternalLibraries folder and Build Everything icon</b></i><p>
[<p align="right"><i>Return to Top</i>](#introduction)<p> <p align="right"><i>[[Return to Top|https://github.com/FIRST-Tech-Challenge/FtcRobotController/wiki/External Libraries in OnBot Java and Blocks]]</i><p>
## Step 3 - Programming ## Step 3 - Programming
@ -104,7 +104,7 @@ It doesn't matter which Java file (if any) is currently open in OBJ; no such fil
See further below for examples of these 3 scenarios. See further below for examples of these 3 scenarios.
[<p align="right"><i>Return to Top</i>](#introduction)<p> <p align="right"><i>[[Return to Top|https://github.com/FIRST-Tech-Challenge/FtcRobotController/wiki/External Libraries in OnBot Java and Blocks]]</i><p>
## User Training & Documentation ## User Training & Documentation
@ -117,7 +117,7 @@ Start with good documentation. For myBlocks, use the existing tools to make hel
Meet with your team's Blocks programmer(s) to explain the new features. Consider writing a short description, for their future reference. Encourage users to give you feedback, to improve your code. Congratulations, you are now a Java developer! Meet with your team's Blocks programmer(s) to explain the new features. Consider writing a short description, for their future reference. Encourage users to give you feedback, to improve your code. Congratulations, you are now a Java developer!
[<p align="right"><i>Return to Top</i>](#introduction)<p> <p align="right"><i>[[Return to Top|https://github.com/FIRST-Tech-Challenge/FtcRobotController/wiki/External Libraries in OnBot Java and Blocks]]</i><p>
## Benefits ## Benefits
@ -131,7 +131,7 @@ This feature can allow a new arrangement: "nobody is left out, and nobody is hel
As a third benefit, FTC judges love to hear about Outreach. For example your team could develop useful Blocks for beginner teams. Or, you share ideas and tips with other advanced teams who are doing the same kind of development. And, you are encouraged to communicate with library developers. This is a good opportunity for real-world interaction with specialists: sharing your needs, and receiving expert guidance. Scientists, engineers, doctors, entrepreneurs -- nobody needs to reinvent the wheel. Professional life is built on these interactions. As a third benefit, FTC judges love to hear about Outreach. For example your team could develop useful Blocks for beginner teams. Or, you share ideas and tips with other advanced teams who are doing the same kind of development. And, you are encouraged to communicate with library developers. This is a good opportunity for real-world interaction with specialists: sharing your needs, and receiving expert guidance. Scientists, engineers, doctors, entrepreneurs -- nobody needs to reinvent the wheel. Professional life is built on these interactions.
[<p align="right"><i>Return to Top</i>](#introduction)<p> <p align="right"><i>[[Return to Top|https://github.com/FIRST-Tech-Challenge/FtcRobotController/wiki/External Libraries in OnBot Java and Blocks]]</i><p>
## Example 1 - non-annotated library ## Example 1 - non-annotated library
@ -194,7 +194,7 @@ On your own, you can try this with the two remaining methods. Use myBlocks to s
<p align="center">[[/images/External-Libraries-in-OnBot-Java-and-Blocks/470-myBlocks-telemetry.png|myBlocks telemetry]] <p align="center">[[/images/External-Libraries-in-OnBot-Java-and-Blocks/470-myBlocks-telemetry.png|myBlocks telemetry]]
<br><i><b>Telemetry of myBlocks using Geometry library</b></i><p> <br><i><b>Telemetry of myBlocks using Geometry library</b></i><p>
[<p align="right"><i>Return to Top</i>](#introduction)<p> <p align="right"><i>[[Return to Top|https://github.com/FIRST-Tech-Challenge/FtcRobotController/wiki/External Libraries in OnBot Java and Blocks]]</i><p>
## Example 2 - FTC-annotated library ## Example 2 - FTC-annotated library
@ -217,7 +217,7 @@ Here are two other "homemade" libraries, both **annotated**. Feel free to exper
- [RevPotentiometer.aar](https://github.com/FIRST-Tech-Challenge/WikiSupport/blob/master/SampleOpModes/External-Libraries-in-OnBot-Java-and-Blocks/RevPotentiometer.aar) contains a class named ```com.example.google.ftc.RevPotentiometer```, which is a hardware device class for the [REV Potentiometer](https://www.revrobotics.com/rev-31-1155/). It uses `AnalogSensorType` and `DeviceProperties` annotations to make this sensor appear in the "Configure Robot" menu of the FTC RC app or paired DS app. After the .aar file has been uploaded (and `Build Everything`), configure your robot's Analog Input Devices and choose `REV Potentiometer`. It has a public method ```getRotation``` with parameter of type AngleUnit. - [RevPotentiometer.aar](https://github.com/FIRST-Tech-Challenge/WikiSupport/blob/master/SampleOpModes/External-Libraries-in-OnBot-Java-and-Blocks/RevPotentiometer.aar) contains a class named ```com.example.google.ftc.RevPotentiometer```, which is a hardware device class for the [REV Potentiometer](https://www.revrobotics.com/rev-31-1155/). It uses `AnalogSensorType` and `DeviceProperties` annotations to make this sensor appear in the "Configure Robot" menu of the FTC RC app or paired DS app. After the .aar file has been uploaded (and `Build Everything`), configure your robot's Analog Input Devices and choose `REV Potentiometer`. It has a public method ```getRotation``` with parameter of type AngleUnit.
[<p align="right"><i>Return to Top</i>](#introduction)<p> <p align="right"><i>[[Return to Top|https://github.com/FIRST-Tech-Challenge/FtcRobotController/wiki/External Libraries in OnBot Java and Blocks]]</i><p>
## Real-world libraries ## Real-world libraries
@ -237,7 +237,7 @@ Also, be aware that the FTC SDK already contains some common Apache classes. On
So, be prepared for these and other challenges that may arise. Again, it's helpful to communicate with the library developer where possible. So, be prepared for these and other challenges that may arise. Again, it's helpful to communicate with the library developer where possible.
[<p align="right"><i>Return to Top</i>](#introduction)<p> <p align="right"><i>[[Return to Top|https://github.com/FIRST-Tech-Challenge/FtcRobotController/wiki/External Libraries in OnBot Java and Blocks]]</i><p>
## Advanced ## Advanced
@ -264,7 +264,7 @@ org.firstinspires.ftc.ftccommon.external.OnDestroy
org.firstinspires.ftc.ftccommon.external.WebHandlerRegistrar org.firstinspires.ftc.ftccommon.external.WebHandlerRegistrar
``` ```
[<p align="right"><i>Return to Top</i>](#introduction)<p> <p align="right"><i>[[Return to Top|https://github.com/FIRST-Tech-Challenge/FtcRobotController/wiki/External Libraries in OnBot Java and Blocks]]</i><p>
## Summary ## Summary
@ -272,7 +272,7 @@ FTC Blocks and OnBot Java programmers can benefit and learn from this new capabi
You are encouraged to submit other examples and suggestions that worked for you. You are encouraged to submit other examples and suggestions that worked for you.
[<p align="right"><i>Return to Top</i>](#introduction)<p> <p align="right"><i>[[Return to Top|https://github.com/FIRST-Tech-Challenge/FtcRobotController/wiki/External Libraries in OnBot Java and Blocks]]</i><p>
============= =============