Skip to content

Commit

Permalink
dev: GSoC: add WebTools auto log analysis project
Browse files Browse the repository at this point in the history
  • Loading branch information
IamPete1 committed Feb 4, 2024
1 parent c9287f5 commit f3f8aa1
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 1 deletion.
15 changes: 15 additions & 0 deletions dev/source/docs/gsoc-ideas-list.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ This is a list of projects suggested by ArduPilot developers for `GSoC 2024 <htt
- Camera and Gimbal enhancements
- Multicopter Swarm Avoidance
- ROS2 support
- WebTools automated log analysis

See lower down on this page for more details for some of the projects listed above

Expand Down Expand Up @@ -109,6 +110,20 @@ Currently, there is no MAVROS equivalent for ROS2, with `OSRF <https://www.openr

A previous GSoC made good progress on this project (see `Dds prototype PR <https://github.com/ArduPilot/ardupilot/pull/17779>`__)

WebTools automated log analysis
-------------------------------

- Skills required: HTML, JavaScript
- Mentor: Peter Hall
- Expected Size: 175h to 350h
- Level of Difficulty: Medium
- Expected Outcome: A new WebTool with the ability to automatically highlight and diagnose common issues from flight logs.

ArduPilot has several `WebTools <https://firmware.ardupilot.org/Tools/WebTools/>`__ for log review, these run in any browser with all computation on the client side. So far we have tools for setup tasks (FilterReivew, PIDReview, MAGFit) and a tool that focuses on hardware issues (HarwareReport).
The next evolution is a tool to look for in-flight issues. There are two existing automated log review tools. `MissionPlanner <https://ardupilot.org/copter/docs/common-downloading-and-analyzing-data-logs-in-mission-planner.html#automatic-analysis-of-logs>`__ includes a basic analysis tool.
`Dronekit log analyzer <https://github.com/dronekit/dronekit-la/tree/master>`__ has a larger number of checks (see: `analyzers <https://github.com/dronekit/dronekit-la/blob/master/docs/reference/analyzers.rst>`__) and would be the initial benchmark for this project.
Once a framework for the tool is up and running checks for as many issues as possible can be added, the tool should focus on making the checks easy to add and update rather than a fancy-looking interface.

Projects Completed in past years
--------------------------------
In 2023, students completed the following projects:
Expand Down
2 changes: 1 addition & 1 deletion dev/source/docs/gsoc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The development team includes experienced mentors who will help students make gr

To help you get started:

- The timeline for `GSoC 2023 is here <https://developers.google.com/open-source/gsoc/timeline>`__
- The timeline for `GSoC 2024 is here <https://developers.google.com/open-source/gsoc/timeline>`__
- The :ref:`suggested projects list <gsoc-ideas-list>` is updated before GSoC begins each year. This is a list of our ideas of what would be good to work on but we are open to other suggestions you make in your application.
- The #GSOC channel in the `ArduPilot Discord server <https://ardupilot.org/discord>`__ is a place to ask questions about our GSOC program, submit ideas for projects, etc. Mentors will respond to your posts in this GSoC channel.
- The :ref:`ArduPilot WIKI <ardupilot:home>` and, specifically, the :ref:`ArduPilot Developers WIKI <dev:home>` are good sources of information on ArduPilot and how to contribute to its code.
Expand Down

0 comments on commit f3f8aa1

Please sign in to comment.