{"id":16607078,"url":"https://github.com/kbumsik/wolfiemouse","last_synced_at":"2025-03-21T14:30:58.412Z","repository":{"id":46152723,"uuid":"46339843","full_name":"kbumsik/WolfieMouse","owner":"kbumsik","description":"IEEE Reion 1 Micromouse competition.","archived":false,"fork":false,"pushed_at":"2021-11-10T22:06:38.000Z","size":30404,"stargazers_count":58,"open_issues_count":8,"forks_count":30,"subscribers_count":14,"default_branch":"master","last_synced_at":"2025-03-18T02:02:56.377Z","etag":null,"topics":["ieee","kicad","maze","micromouse","pcb","robotics","stm32"],"latest_commit_sha":null,"homepage":"","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kbumsik.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-11-17T10:29:05.000Z","updated_at":"2025-02-22T21:31:07.000Z","dependencies_parsed_at":"2022-08-12T12:40:48.350Z","dependency_job_id":null,"html_url":"https://github.com/kbumsik/WolfieMouse","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kbumsik%2FWolfieMouse","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kbumsik%2FWolfieMouse/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kbumsik%2FWolfieMouse/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kbumsik%2FWolfieMouse/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kbumsik","download_url":"https://codeload.github.com/kbumsik/WolfieMouse/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244815084,"owners_count":20514881,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ieee","kicad","maze","micromouse","pcb","robotics","stm32"],"created_at":"2024-10-12T01:11:32.998Z","updated_at":"2025-03-21T14:30:53.403Z","avatar_url":"https://github.com/kbumsik.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"# WolfieMouse\n\nWolfieMouse is a robotics project to build [a micromouse](https://en.wikipedia.org/wiki/Micromouse). This project covers three parts:\n\n* Robotics algorithm for maze solving (C++)\n* low-level hardware driver software (C and ARM assembly)\n* Tools to capture and plot robot's sensor data (Python)\n* Embedded hardware design and PCB design (KiCad, an open-source alternative to Altium)\n\nThis robot won:\n  * **The Special Mention Award in 2018 IEEE Region 1 Micromouse Robotics Competition**.\n  * **The 3rd Place Award in 2019 IEEE Region 1 Micromouse Robotics Competition**.\n\n\u003cimg src=\"doc/images/wolfiemouse_2018.jpg\" width=\"290px\"\u003e\u003cimg src=\"doc/images/wolfiemouse_maze_2018.jpg\" width=\"290px\"\u003e\n\n\u003cimg src=\"doc/images/prize_2018.jpg\" width=\"290px\"\u003e\u003cimg src=\"doc/images/prize_2019.jpg\" width=\"290px\"\u003e\n\n## Get started\n\nIf you don't know what is micromouse competition, [this document will help.](doc/What-is-Micromouse.md).\n\nRequires tools:\n* [GNU Arm Embedded Toolchain](https://developer.arm.com/open-source/gnu-toolchain/gnu-rm) and [Makefile](https://www.gnu.org/software/make/manual/make.html) to build program for the robot.\n* [OpenOCD](http://openocd.org/) to upload the program to the robot and to debug.\n* [KiCad](http://kicad-pcb.org/) to design a PCB hardware.\n\nOtherwise, a [Vagrant](https://www.vagrantup.com/) virtual machine environment is provided to skip installing the above tools.\n\nIf you whish to start with this project, see [get stared document](doc/Get-started.md).\n\n## Documentation\n\nSee [documentation section.](doc/)\n\n## Directory descriptions\n\n* `doc`: Documentation folder\n* `firmware`: The robot's program folder, including robotics algorithms and hardware drivers\n* `simulation`: Programs to test algorithms on a desktop computer\n* `tools`: Contains robot sensor data capturing tools and scripts for Vagrant machine.\n\n## Gallery\n\nTerminal-based simulation program. `M` stands for the position of the robot, `D` stands for the position of the goal in the maze, and `S` stands for the starting position.\n\n![simulation](doc/images/simulation_screen.png)\n\nSchematic overview.\n\n![schematic_overview](doc/images/schematic.png)\n\nPCB Footprint overview.\n\n![pcb_overview](doc/images/pcb_footprint.png)\n\n## License and Credits\n\nSource code in `firmware` and `simulation` folders are licensed under [GPLv2.1](https://www.gnu.org/licenses/old-licenses/lgpl-2.1.en.html).\n\nExternal libraries (FreeRTOS, CMSIS, STM32F4 HAL) under `firmware/lib` follow their own terms.\n\nThe fundamental hardware design is inspired by [Project Futura](http://micromouseusa.com/?page_id=1342) by [Green Ye](http://www.greenye.net/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkbumsik%2Fwolfiemouse","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkbumsik%2Fwolfiemouse","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkbumsik%2Fwolfiemouse/lists"}