📝 PROS 4: Documentation Fixes for optical and distance sensor #654
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Gracelu128
changed the title
noam987
added a commit
that referenced
this pull request
May 5, 2024
* Update version * 🐛 Fix pros::E_TEXT_LARGE_CENTER Simple Name * Update version numbers * 🐛Motor bug fixes and add new set_gearing (#611) * ✨Add list_files function (#612) * Add list_files * renamed c function * Clarify the docs * ✨ ADI Get Port (#613) * Initial Commit. Added get_port() for adi. * Second commit. Fixed changes. * 🐛Vex link default override (#614) * Initial Commit. Changed defualt param. * Fixed param docs * ✨Field Control State Getter (#608) * Field Control State Getter * Fixed merge issues * Removed left over testing code * change macros to enum/functions --------- Co-authored-by: noam987 <noam@arie11.com> Co-authored-by: noam987 <50681033+noam987@users.noreply.github.com> * Added vexFileSync when writing to files (#619) * 🐛Fix rotation sensor reversed port (#618) * 🐛 Field Control Getter Return Value (#627) * Field Control State Getter * Fixed merge issues * Removed left over testing code * change macros to enum/functions * fix return value issue * fixed version --------- Co-authored-by: noam987 <noam@arie11.com> Co-authored-by: noam987 <50681033+noam987@users.noreply.github.com> * ✨default the VFS to the sd card (#621) * Fix motor voltage limit port mutex returning * Initial implementation for get_all_devices * Remove use of templating * modify gps functions * add example code to gps header files * revert api.h and version * add newline at end of gps.c * add newline at end of version * Completed get_all_devices member function for all critical devices * Fix compile issues * 🐛ADI mutex fix (#633) * Fixed duplicate zero indexing in ext_adi_led_set_pixel as well as validate_type * testing * Fixed zero indexing * fix merge * removes an extra -1 * Add missing -1 * Last -1 * Fix return without releasing mutex --------- Co-authored-by: noam987 <noam@arie11.com> * ✨Adds static getters for some devices (#653) * imu_v1 * revert main.cpp * Add injector for gps * rename to _ casing and add vision sensor * 📝 PROS 4: Documentation Fixes for optical and distance sensor (#654) * Documentation Fixes for optical sensor * Distance sensor documentation fixes * Added alias function get_distance for get for distance sensor * Update get_distance func header for distance sensor * 🐛Fixed Imu::is_calibrating function for PROS 4 #626 (#629) * Fixed Imu::is_calibrating function Updated imu status enums to properly reflect values returned by get_status. Also modifed imu::is_calibrating so it returns the correct value. * Bugfixes from the pros 3 version --------- Co-authored-by: noam987 <noam@arie11.com> Co-authored-by: noam987 <50681033+noam987@users.noreply.github.com> * 🐛Remove = overload from motor groups (#656) --------- Co-authored-by: Richard Stump <rnstump@purdue.edu> Co-authored-by: Will Xu <xu1321@purdue.edu> Co-authored-by: Will Xu <54247087+WillXuCodes@users.noreply.github.com> Co-authored-by: phinc23 <60949293+phinc23@users.noreply.github.com> Co-authored-by: Yuechan Li <55300543+CChheerryyll@users.noreply.github.com> Co-authored-by: Sprocket Riggs <34726295+aberiggs@users.noreply.github.com> Co-authored-by: Cooper7196 <cbrosgall@shaw.ca> Co-authored-by: Gavin-Niederman <gavinniederman@gmail.com> Co-authored-by: aberiggs <sprocket710@gmail.com> Co-authored-by: Yuechan Li <liyuechan2018@gmail.com> Co-authored-by: Gracelu128 <112266075+Gracelu128@users.noreply.github.com> Co-authored-by: Richard Li <61027374+R11G@users.noreply.github.com>
noam987
added a commit
that referenced
this pull request
May 18, 2024
…ad of MotorGroup& (#661) * 📝Update docs for pre-release (#657) * Update version * 🐛 Fix pros::E_TEXT_LARGE_CENTER Simple Name * Update version numbers * 🐛Motor bug fixes and add new set_gearing (#611) * ✨Add list_files function (#612) * Add list_files * renamed c function * Clarify the docs * ✨ ADI Get Port (#613) * Initial Commit. Added get_port() for adi. * Second commit. Fixed changes. * 🐛Vex link default override (#614) * Initial Commit. Changed defualt param. * Fixed param docs * ✨Field Control State Getter (#608) * Field Control State Getter * Fixed merge issues * Removed left over testing code * change macros to enum/functions --------- Co-authored-by: noam987 <noam@arie11.com> Co-authored-by: noam987 <50681033+noam987@users.noreply.github.com> * Added vexFileSync when writing to files (#619) * 🐛Fix rotation sensor reversed port (#618) * 🐛 Field Control Getter Return Value (#627) * Field Control State Getter * Fixed merge issues * Removed left over testing code * change macros to enum/functions * fix return value issue * fixed version --------- Co-authored-by: noam987 <noam@arie11.com> Co-authored-by: noam987 <50681033+noam987@users.noreply.github.com> * ✨default the VFS to the sd card (#621) * Fix motor voltage limit port mutex returning * Initial implementation for get_all_devices * Remove use of templating * modify gps functions * add example code to gps header files * revert api.h and version * add newline at end of gps.c * add newline at end of version * Completed get_all_devices member function for all critical devices * Fix compile issues * 🐛ADI mutex fix (#633) * Fixed duplicate zero indexing in ext_adi_led_set_pixel as well as validate_type * testing * Fixed zero indexing * fix merge * removes an extra -1 * Add missing -1 * Last -1 * Fix return without releasing mutex --------- Co-authored-by: noam987 <noam@arie11.com> * ✨Adds static getters for some devices (#653) * imu_v1 * revert main.cpp * Add injector for gps * rename to _ casing and add vision sensor * 📝 PROS 4: Documentation Fixes for optical and distance sensor (#654) * Documentation Fixes for optical sensor * Distance sensor documentation fixes * Added alias function get_distance for get for distance sensor * Update get_distance func header for distance sensor * 🐛Fixed Imu::is_calibrating function for PROS 4 #626 (#629) * Fixed Imu::is_calibrating function Updated imu status enums to properly reflect values returned by get_status. Also modifed imu::is_calibrating so it returns the correct value. * Bugfixes from the pros 3 version --------- Co-authored-by: noam987 <noam@arie11.com> Co-authored-by: noam987 <50681033+noam987@users.noreply.github.com> * 🐛Remove = overload from motor groups (#656) --------- Co-authored-by: Richard Stump <rnstump@purdue.edu> Co-authored-by: Will Xu <xu1321@purdue.edu> Co-authored-by: Will Xu <54247087+WillXuCodes@users.noreply.github.com> Co-authored-by: phinc23 <60949293+phinc23@users.noreply.github.com> Co-authored-by: Yuechan Li <55300543+CChheerryyll@users.noreply.github.com> Co-authored-by: Sprocket Riggs <34726295+aberiggs@users.noreply.github.com> Co-authored-by: Cooper7196 <cbrosgall@shaw.ca> Co-authored-by: Gavin-Niederman <gavinniederman@gmail.com> Co-authored-by: aberiggs <sprocket710@gmail.com> Co-authored-by: Yuechan Li <liyuechan2018@gmail.com> Co-authored-by: Gracelu128 <112266075+Gracelu128@users.noreply.github.com> Co-authored-by: Richard Li <61027374+R11G@users.noreply.github.com> * Fix motor docs * minor docs fixes * Compiles, haven't tested past that * Revert main.cpp * remove extra includes in main * another small style fix * ixed issue found during testing --------- Co-authored-by: Richard Stump <rnstump@purdue.edu> Co-authored-by: Will Xu <xu1321@purdue.edu> Co-authored-by: Will Xu <54247087+WillXuCodes@users.noreply.github.com> Co-authored-by: phinc23 <60949293+phinc23@users.noreply.github.com> Co-authored-by: Yuechan Li <55300543+CChheerryyll@users.noreply.github.com> Co-authored-by: Sprocket Riggs <34726295+aberiggs@users.noreply.github.com> Co-authored-by: Cooper7196 <cbrosgall@shaw.ca> Co-authored-by: Gavin-Niederman <gavinniederman@gmail.com> Co-authored-by: aberiggs <sprocket710@gmail.com> Co-authored-by: Yuechan Li <liyuechan2018@gmail.com> Co-authored-by: Gracelu128 <112266075+Gracelu128@users.noreply.github.com> Co-authored-by: Richard Li <61027374+R11G@users.noreply.github.com>
phinc23
added a commit
that referenced
this pull request
May 19, 2024
* Start of work on motors docs * Add descriptions for color files. * Error.h * gps.hpp done * Gps.h done * More motors docs * Motor docs and fixed the build * added changes to device.hpp, distance.hpp and imu.hpp * Revert "added changes to device.hpp, distance.hpp and" This reverts commit 380a2de. * Do the link files * attempt to fix issue with ADI * Fix ADI Doc value * Remove accidental addition of extra bracket * AbstractMotor work * attempt to refix something * yep looks like that was the culprit * Add it back because it was breaking stuff * The serial files * Optical cpp examples * Get rid of legacy api file (nobody uses PROS 2 API anymore) * Update documentation for the llemu api * Update rtos.h * Attempt to fix adi doc bracketing * Update rtos.h * Fix up formatting on rtos.h * try something really stupid * Finished functions in motors.h * progress on motors.hpp * Update adi bracketting * Fix adi.h bracketing again * Comment brackets in rtos.h * Try removing \enum and \typedef to see if that breaks m.css * Try removing \def * Try some more things to fix CI * Strip name and group commands to see if that lets the CI get further * More more motors.hpp work * Update rtos.h * More rtos.h updates * abstract motor work * rotation.h and rotation.hpp documentation * Fixes to code examples. * do some of the _all functions * more stuff * imu_set_euler * MOTORS.HPP DONE * added example for device.h * fix typo * added example for device.hpp * fix issue * fix formatting * fix and add example in distance.h * WIP on rtos.hpp * ext_adi.h file * fix typo in distance.h * motors and motor group fixes * Trying to fix motor linking * Wip in rtos * update example in device.hpp * updated device.hpp examples * updated distance.hpp examples * fix typo in device.h * fix typo in device.hpp * Vision c++ header docs * Update motors * docs for mics, screen and abstract_motor(enum) * Fix up device file, apix.h work * added example for constructors in device.hpp and distance.hpp * imu.hpp function examples * Small edit for imu.hpp function examples * Added header for imu.hpp constructor * Small edit for imu.hpp constructor header * Remove links * Fix up color and device files * Finish rtos.h and rtos.hpp * Fix cpp-link * Fixes to motors docs * Rotation.hpp docs updates * Reverse Flag param in Rotation constructor * Formatting fixes * Fix motor groups and fix colors * fixed file for motor group * Fix bracketing * Fix MG docs * Remove PROS 2 references, fix up readmes * Another fix * Most of the work done for motor groups * Fix missing end codes * Almost done * FINISHED MOTOR GROUPS * added namespace for screen.hpp * Update version * Fix a couple enum/struct issues * 📝 Some fixes for motor headers * 📝 Some fixes for enums * 🐛Motor bug fixes and add new set_gearing (#611) * ✨Add list_files function (#612) * Add list_files * renamed c function * Clarify the docs * ✨ ADI Get Port (#613) * Initial Commit. Added get_port() for adi. * Second commit. Fixed changes. * 🐛Vex link default override (#614) * Initial Commit. Changed defualt param. * Fixed param docs * ✨Field Control State Getter (#608) * Field Control State Getter * Fixed merge issues * Removed left over testing code * change macros to enum/functions --------- Co-authored-by: noam987 <noam@arie11.com> Co-authored-by: noam987 <50681033+noam987@users.noreply.github.com> * Added vexFileSync when writing to files (#619) * 🐛Fix rotation sensor reversed port (#618) * 🐛 Field Control Getter Return Value (#627) * Field Control State Getter * Fixed merge issues * Removed left over testing code * change macros to enum/functions * fix return value issue * fixed version --------- Co-authored-by: noam987 <noam@arie11.com> Co-authored-by: noam987 <50681033+noam987@users.noreply.github.com> * ✨default the VFS to the sd card (#621) * Fix motor voltage limit port mutex returning * Initial implementation for get_all_devices * Remove use of templating * modify gps functions * add example code to gps header files * revert api.h and version * add newline at end of gps.c * add newline at end of version * Completed get_all_devices member function for all critical devices * Fix compile issues * 🐛ADI mutex fix (#633) * Fixed duplicate zero indexing in ext_adi_led_set_pixel as well as validate_type * testing * Fixed zero indexing * fix merge * removes an extra -1 * Add missing -1 * Last -1 * Fix return without releasing mutex --------- Co-authored-by: noam987 <noam@arie11.com> * ✨Adds static getters for some devices (#653) * imu_v1 * revert main.cpp * Add injector for gps * rename to _ casing and add vision sensor * 📝 PROS 4: Documentation Fixes for optical and distance sensor (#654) * Documentation Fixes for optical sensor * Distance sensor documentation fixes * Added alias function get_distance for get for distance sensor * Update get_distance func header for distance sensor * 🐛Fixed Imu::is_calibrating function for PROS 4 #626 (#629) * Fixed Imu::is_calibrating function Updated imu status enums to properly reflect values returned by get_status. Also modifed imu::is_calibrating so it returns the correct value. * Bugfixes from the pros 3 version --------- Co-authored-by: noam987 <noam@arie11.com> Co-authored-by: noam987 <50681033+noam987@users.noreply.github.com> * 🐛Remove = overload from motor groups (#656) * 📝Update docs for pre-release (#657) * Update version * 🐛 Fix pros::E_TEXT_LARGE_CENTER Simple Name * Update version numbers * 🐛Motor bug fixes and add new set_gearing (#611) * ✨Add list_files function (#612) * Add list_files * renamed c function * Clarify the docs * ✨ ADI Get Port (#613) * Initial Commit. Added get_port() for adi. * Second commit. Fixed changes. * 🐛Vex link default override (#614) * Initial Commit. Changed defualt param. * Fixed param docs * ✨Field Control State Getter (#608) * Field Control State Getter * Fixed merge issues * Removed left over testing code * change macros to enum/functions --------- Co-authored-by: noam987 <noam@arie11.com> Co-authored-by: noam987 <50681033+noam987@users.noreply.github.com> * Added vexFileSync when writing to files (#619) * 🐛Fix rotation sensor reversed port (#618) * 🐛 Field Control Getter Return Value (#627) * Field Control State Getter * Fixed merge issues * Removed left over testing code * change macros to enum/functions * fix return value issue * fixed version --------- Co-authored-by: noam987 <noam@arie11.com> Co-authored-by: noam987 <50681033+noam987@users.noreply.github.com> * ✨default the VFS to the sd card (#621) * Fix motor voltage limit port mutex returning * Initial implementation for get_all_devices * Remove use of templating * modify gps functions * add example code to gps header files * revert api.h and version * add newline at end of gps.c * add newline at end of version * Completed get_all_devices member function for all critical devices * Fix compile issues * 🐛ADI mutex fix (#633) * Fixed duplicate zero indexing in ext_adi_led_set_pixel as well as validate_type * testing * Fixed zero indexing * fix merge * removes an extra -1 * Add missing -1 * Last -1 * Fix return without releasing mutex --------- Co-authored-by: noam987 <noam@arie11.com> * ✨Adds static getters for some devices (#653) * imu_v1 * revert main.cpp * Add injector for gps * rename to _ casing and add vision sensor * 📝 PROS 4: Documentation Fixes for optical and distance sensor (#654) * Documentation Fixes for optical sensor * Distance sensor documentation fixes * Added alias function get_distance for get for distance sensor * Update get_distance func header for distance sensor * 🐛Fixed Imu::is_calibrating function for PROS 4 #626 (#629) * Fixed Imu::is_calibrating function Updated imu status enums to properly reflect values returned by get_status. Also modifed imu::is_calibrating so it returns the correct value. * Bugfixes from the pros 3 version --------- Co-authored-by: noam987 <noam@arie11.com> Co-authored-by: noam987 <50681033+noam987@users.noreply.github.com> * 🐛Remove = overload from motor groups (#656) --------- Co-authored-by: Richard Stump <rnstump@purdue.edu> Co-authored-by: Will Xu <xu1321@purdue.edu> Co-authored-by: Will Xu <54247087+WillXuCodes@users.noreply.github.com> Co-authored-by: phinc23 <60949293+phinc23@users.noreply.github.com> Co-authored-by: Yuechan Li <55300543+CChheerryyll@users.noreply.github.com> Co-authored-by: Sprocket Riggs <34726295+aberiggs@users.noreply.github.com> Co-authored-by: Cooper7196 <cbrosgall@shaw.ca> Co-authored-by: Gavin-Niederman <gavinniederman@gmail.com> Co-authored-by: aberiggs <sprocket710@gmail.com> Co-authored-by: Yuechan Li <liyuechan2018@gmail.com> Co-authored-by: Gracelu128 <112266075+Gracelu128@users.noreply.github.com> Co-authored-by: Richard Li <61027374+R11G@users.noreply.github.com> * Update version numbers (#658) * 🐛Fix imu get device typo (#659) * Fix motor docs * minor docs fixes * 📝 Fix typo in main.h (#662) * Add documentation to literals * 📝 Fix typo in main.cpp (#663) * Fix a typo in main.h * Fix a typo in main.cpp * 🐛Converts appending, and constructors to take in AbstractMotor& instead of MotorGroup& (#661) * 📝Update docs for pre-release (#657) * Update version * 🐛 Fix pros::E_TEXT_LARGE_CENTER Simple Name * Update version numbers * 🐛Motor bug fixes and add new set_gearing (#611) * ✨Add list_files function (#612) * Add list_files * renamed c function * Clarify the docs * ✨ ADI Get Port (#613) * Initial Commit. Added get_port() for adi. * Second commit. Fixed changes. * 🐛Vex link default override (#614) * Initial Commit. Changed defualt param. * Fixed param docs * ✨Field Control State Getter (#608) * Field Control State Getter * Fixed merge issues * Removed left over testing code * change macros to enum/functions --------- Co-authored-by: noam987 <noam@arie11.com> Co-authored-by: noam987 <50681033+noam987@users.noreply.github.com> * Added vexFileSync when writing to files (#619) * 🐛Fix rotation sensor reversed port (#618) * 🐛 Field Control Getter Return Value (#627) * Field Control State Getter * Fixed merge issues * Removed left over testing code * change macros to enum/functions * fix return value issue * fixed version --------- Co-authored-by: noam987 <noam@arie11.com> Co-authored-by: noam987 <50681033+noam987@users.noreply.github.com> * ✨default the VFS to the sd card (#621) * Fix motor voltage limit port mutex returning * Initial implementation for get_all_devices * Remove use of templating * modify gps functions * add example code to gps header files * revert api.h and version * add newline at end of gps.c * add newline at end of version * Completed get_all_devices member function for all critical devices * Fix compile issues * 🐛ADI mutex fix (#633) * Fixed duplicate zero indexing in ext_adi_led_set_pixel as well as validate_type * testing * Fixed zero indexing * fix merge * removes an extra -1 * Add missing -1 * Last -1 * Fix return without releasing mutex --------- Co-authored-by: noam987 <noam@arie11.com> * ✨Adds static getters for some devices (#653) * imu_v1 * revert main.cpp * Add injector for gps * rename to _ casing and add vision sensor * 📝 PROS 4: Documentation Fixes for optical and distance sensor (#654) * Documentation Fixes for optical sensor * Distance sensor documentation fixes * Added alias function get_distance for get for distance sensor * Update get_distance func header for distance sensor * 🐛Fixed Imu::is_calibrating function for PROS 4 #626 (#629) * Fixed Imu::is_calibrating function Updated imu status enums to properly reflect values returned by get_status. Also modifed imu::is_calibrating so it returns the correct value. * Bugfixes from the pros 3 version --------- Co-authored-by: noam987 <noam@arie11.com> Co-authored-by: noam987 <50681033+noam987@users.noreply.github.com> * 🐛Remove = overload from motor groups (#656) --------- Co-authored-by: Richard Stump <rnstump@purdue.edu> Co-authored-by: Will Xu <xu1321@purdue.edu> Co-authored-by: Will Xu <54247087+WillXuCodes@users.noreply.github.com> Co-authored-by: phinc23 <60949293+phinc23@users.noreply.github.com> Co-authored-by: Yuechan Li <55300543+CChheerryyll@users.noreply.github.com> Co-authored-by: Sprocket Riggs <34726295+aberiggs@users.noreply.github.com> Co-authored-by: Cooper7196 <cbrosgall@shaw.ca> Co-authored-by: Gavin-Niederman <gavinniederman@gmail.com> Co-authored-by: aberiggs <sprocket710@gmail.com> Co-authored-by: Yuechan Li <liyuechan2018@gmail.com> Co-authored-by: Gracelu128 <112266075+Gracelu128@users.noreply.github.com> Co-authored-by: Richard Li <61027374+R11G@users.noreply.github.com> * Fix motor docs * minor docs fixes * Compiles, haven't tested past that * Revert main.cpp * remove extra includes in main * another small style fix * ixed issue found during testing --------- Co-authored-by: Richard Stump <rnstump@purdue.edu> Co-authored-by: Will Xu <xu1321@purdue.edu> Co-authored-by: Will Xu <54247087+WillXuCodes@users.noreply.github.com> Co-authored-by: phinc23 <60949293+phinc23@users.noreply.github.com> Co-authored-by: Yuechan Li <55300543+CChheerryyll@users.noreply.github.com> Co-authored-by: Sprocket Riggs <34726295+aberiggs@users.noreply.github.com> Co-authored-by: Cooper7196 <cbrosgall@shaw.ca> Co-authored-by: Gavin-Niederman <gavinniederman@gmail.com> Co-authored-by: aberiggs <sprocket710@gmail.com> Co-authored-by: Yuechan Li <liyuechan2018@gmail.com> Co-authored-by: Gracelu128 <112266075+Gracelu128@users.noreply.github.com> Co-authored-by: Richard Li <61027374+R11G@users.noreply.github.com> * 📝Docs + implementation forgotten for rotation sensor (#665) * Fix compile issues * Update version nums --------- Co-authored-by: Noam987 <noam@arie11.com> Co-authored-by: Will Xu <xu1321@purdue.edu> Co-authored-by: Richard Stump <rnstump@purdue.edu> Co-authored-by: Aaryan Gautam <64756497+aaryan-gautam@users.noreply.github.com> Co-authored-by: Andrew Lu <lu987@purdue.edu> Co-authored-by: aberiggs <sprocket710@gmail.com> Co-authored-by: Grace Lu <lu986@purdue.edu> Co-authored-by: AnnZi <lauannzi2002@gmail.com> Co-authored-by: Jerrylum <serverofjerry@gmail.com> Co-authored-by: Will Xu <54247087+WillXuCodes@users.noreply.github.com> Co-authored-by: noam987 <50681033+noam987@users.noreply.github.com> Co-authored-by: Yuechan Li <55300543+CChheerryyll@users.noreply.github.com> Co-authored-by: Sprocket Riggs <34726295+aberiggs@users.noreply.github.com> Co-authored-by: Cooper7196 <cbrosgall@shaw.ca> Co-authored-by: Gavin-Niederman <gavinniederman@gmail.com> Co-authored-by: Yuechan Li <liyuechan2018@gmail.com> Co-authored-by: Gracelu128 <112266075+Gracelu128@users.noreply.github.com> Co-authored-by: Richard Li <61027374+R11G@users.noreply.github.com> Co-authored-by: THERocky <101498190+Rocky14683@users.noreply.github.com>
noam987
added a commit
that referenced
this pull request
May 19, 2024
* Start of work on motors docs * Add descriptions for color files. * Error.h * gps.hpp done * Gps.h done * More motors docs * Motor docs and fixed the build * added changes to device.hpp, distance.hpp and imu.hpp * Revert "added changes to device.hpp, distance.hpp and" This reverts commit 380a2de. * Do the link files * attempt to fix issue with ADI * Fix ADI Doc value * Remove accidental addition of extra bracket * AbstractMotor work * attempt to refix something * yep looks like that was the culprit * Add it back because it was breaking stuff * The serial files * Optical cpp examples * Get rid of legacy api file (nobody uses PROS 2 API anymore) * Update documentation for the llemu api * Update rtos.h * Attempt to fix adi doc bracketing * Update rtos.h * Fix up formatting on rtos.h * try something really stupid * Finished functions in motors.h * progress on motors.hpp * Update adi bracketting * Fix adi.h bracketing again * Comment brackets in rtos.h * Try removing \enum and \typedef to see if that breaks m.css * Try removing \def * Try some more things to fix CI * Strip name and group commands to see if that lets the CI get further * More more motors.hpp work * Update rtos.h * More rtos.h updates * abstract motor work * rotation.h and rotation.hpp documentation * Fixes to code examples. * do some of the _all functions * more stuff * imu_set_euler * MOTORS.HPP DONE * added example for device.h * fix typo * added example for device.hpp * fix issue * fix formatting * fix and add example in distance.h * WIP on rtos.hpp * ext_adi.h file * fix typo in distance.h * motors and motor group fixes * Trying to fix motor linking * Wip in rtos * update example in device.hpp * updated device.hpp examples * updated distance.hpp examples * fix typo in device.h * fix typo in device.hpp * Vision c++ header docs * Update motors * docs for mics, screen and abstract_motor(enum) * Fix up device file, apix.h work * added example for constructors in device.hpp and distance.hpp * imu.hpp function examples * Small edit for imu.hpp function examples * Added header for imu.hpp constructor * Small edit for imu.hpp constructor header * Remove links * Fix up color and device files * Finish rtos.h and rtos.hpp * Fix cpp-link * Fixes to motors docs * Rotation.hpp docs updates * Reverse Flag param in Rotation constructor * Formatting fixes * Fix motor groups and fix colors * fixed file for motor group * Fix bracketing * Fix MG docs * Remove PROS 2 references, fix up readmes * Another fix * Most of the work done for motor groups * Fix missing end codes * Almost done * FINISHED MOTOR GROUPS * added namespace for screen.hpp * Update version * Fix a couple enum/struct issues * 📝 Some fixes for motor headers * 📝 Some fixes for enums * 🐛Motor bug fixes and add new set_gearing (#611) * ✨Add list_files function (#612) * Add list_files * renamed c function * Clarify the docs * ✨ ADI Get Port (#613) * Initial Commit. Added get_port() for adi. * Second commit. Fixed changes. * 🐛Vex link default override (#614) * Initial Commit. Changed defualt param. * Fixed param docs * ✨Field Control State Getter (#608) * Field Control State Getter * Fixed merge issues * Removed left over testing code * change macros to enum/functions --------- * Added vexFileSync when writing to files (#619) * 🐛Fix rotation sensor reversed port (#618) * 🐛 Field Control Getter Return Value (#627) * Field Control State Getter * Fixed merge issues * Removed left over testing code * change macros to enum/functions * fix return value issue * fixed version --------- * ✨default the VFS to the sd card (#621) * Fix motor voltage limit port mutex returning * Initial implementation for get_all_devices * Remove use of templating * modify gps functions * add example code to gps header files * revert api.h and version * add newline at end of gps.c * add newline at end of version * Completed get_all_devices member function for all critical devices * Fix compile issues * 🐛ADI mutex fix (#633) * Fixed duplicate zero indexing in ext_adi_led_set_pixel as well as validate_type * testing * Fixed zero indexing * fix merge * removes an extra -1 * Add missing -1 * Last -1 * Fix return without releasing mutex --------- * ✨Adds static getters for some devices (#653) * imu_v1 * revert main.cpp * Add injector for gps * rename to _ casing and add vision sensor * 📝 PROS 4: Documentation Fixes for optical and distance sensor (#654) * Documentation Fixes for optical sensor * Distance sensor documentation fixes * Added alias function get_distance for get for distance sensor * Update get_distance func header for distance sensor * 🐛Fixed Imu::is_calibrating function for PROS 4 #626 (#629) * Fixed Imu::is_calibrating function Updated imu status enums to properly reflect values returned by get_status. Also modifed imu::is_calibrating so it returns the correct value. * Bugfixes from the pros 3 version --------- * 🐛Remove = overload from motor groups (#656) * 📝Update docs for pre-release (#657) * Update version * 🐛 Fix pros::E_TEXT_LARGE_CENTER Simple Name * Update version numbers * 🐛Motor bug fixes and add new set_gearing (#611) * ✨Add list_files function (#612) * Add list_files * renamed c function * Clarify the docs * ✨ ADI Get Port (#613) * Initial Commit. Added get_port() for adi. * Second commit. Fixed changes. * 🐛Vex link default override (#614) * Initial Commit. Changed defualt param. * Fixed param docs * ✨Field Control State Getter (#608) * Field Control State Getter * Fixed merge issues * Removed left over testing code * change macros to enum/functions --------- * Added vexFileSync when writing to files (#619) * 🐛Fix rotation sensor reversed port (#618) * 🐛 Field Control Getter Return Value (#627) * Field Control State Getter * Fixed merge issues * Removed left over testing code * change macros to enum/functions * fix return value issue * fixed version --------- * ✨default the VFS to the sd card (#621) * Fix motor voltage limit port mutex returning * Initial implementation for get_all_devices * Remove use of templating * modify gps functions * add example code to gps header files * revert api.h and version * add newline at end of gps.c * add newline at end of version * Completed get_all_devices member function for all critical devices * Fix compile issues * 🐛ADI mutex fix (#633) * Fixed duplicate zero indexing in ext_adi_led_set_pixel as well as validate_type * testing * Fixed zero indexing * fix merge * removes an extra -1 * Add missing -1 * Last -1 * Fix return without releasing mutex --------- * ✨Adds static getters for some devices (#653) * imu_v1 * revert main.cpp * Add injector for gps * rename to _ casing and add vision sensor * 📝 PROS 4: Documentation Fixes for optical and distance sensor (#654) * Documentation Fixes for optical sensor * Distance sensor documentation fixes * Added alias function get_distance for get for distance sensor * Update get_distance func header for distance sensor * 🐛Fixed Imu::is_calibrating function for PROS 4 #626 (#629) * Fixed Imu::is_calibrating function Updated imu status enums to properly reflect values returned by get_status. Also modifed imu::is_calibrating so it returns the correct value. * Bugfixes from the pros 3 version --------- * 🐛Remove = overload from motor groups (#656) --------- * Update version numbers (#658) * 🐛Fix imu get device typo (#659) * Fix motor docs * minor docs fixes * 📝 Fix typo in main.h (#662) * Add documentation to literals * 📝 Fix typo in main.cpp (#663) * Fix a typo in main.h * Fix a typo in main.cpp * 🐛Converts appending, and constructors to take in AbstractMotor& instead of MotorGroup& (#661) * 📝Update docs for pre-release (#657) * Update version * 🐛 Fix pros::E_TEXT_LARGE_CENTER Simple Name * Update version numbers * 🐛Motor bug fixes and add new set_gearing (#611) * ✨Add list_files function (#612) * Add list_files * renamed c function * Clarify the docs * ✨ ADI Get Port (#613) * Initial Commit. Added get_port() for adi. * Second commit. Fixed changes. * 🐛Vex link default override (#614) * Initial Commit. Changed defualt param. * Fixed param docs * ✨Field Control State Getter (#608) * Field Control State Getter * Fixed merge issues * Removed left over testing code * change macros to enum/functions --------- * Added vexFileSync when writing to files (#619) * 🐛Fix rotation sensor reversed port (#618) * 🐛 Field Control Getter Return Value (#627) * Field Control State Getter * Fixed merge issues * Removed left over testing code * change macros to enum/functions * fix return value issue * fixed version --------- * ✨default the VFS to the sd card (#621) * Fix motor voltage limit port mutex returning * Initial implementation for get_all_devices * Remove use of templating * modify gps functions * add example code to gps header files * revert api.h and version * add newline at end of gps.c * add newline at end of version * Completed get_all_devices member function for all critical devices * Fix compile issues * 🐛ADI mutex fix (#633) * Fixed duplicate zero indexing in ext_adi_led_set_pixel as well as validate_type * testing * Fixed zero indexing * fix merge * removes an extra -1 * Add missing -1 * Last -1 * Fix return without releasing mutex --------- * ✨Adds static getters for some devices (#653) * imu_v1 * revert main.cpp * Add injector for gps * rename to _ casing and add vision sensor * 📝 PROS 4: Documentation Fixes for optical and distance sensor (#654) * Documentation Fixes for optical sensor * Distance sensor documentation fixes * Added alias function get_distance for get for distance sensor * Update get_distance func header for distance sensor * 🐛Fixed Imu::is_calibrating function for PROS 4 #626 (#629) * Fixed Imu::is_calibrating function Updated imu status enums to properly reflect values returned by get_status. Also modifed imu::is_calibrating so it returns the correct value. * Bugfixes from the pros 3 version --------- * 🐛Remove = overload from motor groups (#656) --------- * Fix motor docs * minor docs fixes * Compiles, haven't tested past that * Revert main.cpp * remove extra includes in main * another small style fix * ixed issue found during testing --------- * 📝Docs + implementation forgotten for rotation sensor (#665) * Fix compile issues * Update version nums --------- Co-authored-by: phinc23 <60949293+phinc23@users.noreply.github.com> Co-authored-by: Will Xu <xu1321@purdue.edu> Co-authored-by: Richard Stump <rnstump@purdue.edu> Co-authored-by: Aaryan Gautam <64756497+aaryan-gautam@users.noreply.github.com> Co-authored-by: Andrew Lu <lu987@purdue.edu> Co-authored-by: aberiggs <sprocket710@gmail.com> Co-authored-by: Grace Lu <lu986@purdue.edu> Co-authored-by: AnnZi <lauannzi2002@gmail.com> Co-authored-by: Jerrylum <serverofjerry@gmail.com> Co-authored-by: Will Xu <54247087+WillXuCodes@users.noreply.github.com> Co-authored-by: Yuechan Li <55300543+CChheerryyll@users.noreply.github.com> Co-authored-by: Sprocket Riggs <34726295+aberiggs@users.noreply.github.com> Co-authored-by: Cooper7196 <cbrosgall@shaw.ca> Co-authored-by: Gavin-Niederman <gavinniederman@gmail.com> Co-authored-by: Yuechan Li <liyuechan2018@gmail.com> Co-authored-by: Gracelu128 <112266075+Gracelu128@users.noreply.github.com> Co-authored-by: Richard Li <61027374+R11G@users.noreply.github.com> Co-authored-by: THERocky <101498190+Rocky14683@users.noreply.github.com>
ion098
pushed a commit
to ion098/pros
that referenced
this pull request
Jul 16, 2024
…sigbots#654) * Documentation Fixes for optical sensor * Distance sensor documentation fixes * Added alias function get_distance for get for distance sensor * Update get_distance func header for distance sensor
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary:
Fixed documentation for optical sensor. Added alias function get_distance() for get() function.
Motivation:
Docs properly display all functions for optical sensor