{"id":18037714,"url":"https://github.com/tmthecoder/odometrycore","last_synced_at":"2025-07-23T12:08:29.700Z","repository":{"id":114925697,"uuid":"310392151","full_name":"tmthecoder/OdometryCore","owner":"tmthecoder","description":"Odometry Core Tracking Algorithm Written in Java","archived":false,"fork":false,"pushed_at":"2021-06-11T15:02:11.000Z","size":201,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-05T00:27:18.606Z","etag":null,"topics":["odometry","position-tracking"],"latest_commit_sha":null,"homepage":"https://docs.tmthecoder.dev/OdometryCore","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tmthecoder.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-11-05T19:02:29.000Z","updated_at":"2024-09-27T17:08:56.000Z","dependencies_parsed_at":null,"dependency_job_id":"6e300b20-69a2-4469-90dd-09e2d08991a2","html_url":"https://github.com/tmthecoder/OdometryCore","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/tmthecoder/OdometryCore","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tmthecoder%2FOdometryCore","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tmthecoder%2FOdometryCore/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tmthecoder%2FOdometryCore/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tmthecoder%2FOdometryCore/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tmthecoder","download_url":"https://codeload.github.com/tmthecoder/OdometryCore/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tmthecoder%2FOdometryCore/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266673580,"owners_count":23966375,"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","status":"online","status_checked_at":"2025-07-23T02:00:09.312Z","response_time":66,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["odometry","position-tracking"],"created_at":"2024-10-30T13:13:26.045Z","updated_at":"2025-07-23T12:08:29.673Z","avatar_url":"https://github.com/tmthecoder.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Odometry Core\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n\nThis is a library made to handle the core mathematical calculations for three wheel Odometry.\n\nThis library requires either a value in encoder ticks, paired with the counts per revolution per encoder, or an inch value for each encoder to be given\n\n## Installation (Gradle)\nIn order to use this library, paste the following code under your ``allprojects/repositories``:\n\n```\nallprojects {\n    repositories {\n        jcenter()\n        maven { url \"https://jitpack.io\" }  //Add this line\n    }\n}\n``` \n\nThen place the following line under your ```dependencies```:\n```\ndependencies {\n    implementation 'com.github.tmthecoder:OdometryCore:1.0.0'\n}\n```\n## Installation (JAR)\n\nAlternatively, you can use the provided JAR in the releases section under the latest released version\n\n## Usage\n\n**Library Initialization:**\n```\nOdometryCore.initialize(cpr, diameter, leftOffet, rightOffset, frontBackOffset);\n```\nThe parameters seen are:\n- cpr: The counts per revolution for the encoders you are using\n- diameter: The diameter of the wheels on the encoder\n- leftOffset: The offset of the left wheel from the center of the robot (only horizontal offset)\n- rightOffset: The offset of the right wheel from the center of the robot (only horizontal offset)\n- frontBackOffset: The offset of the front or back encoder wheel (only vertical offset)\n\n**Position Tracking:**\n\nAfter initializing, the robot's position can be found using the following code:\n```               \nEncoderPositions encoderPositions = new EncoderPositions(leftPosition, rightPosition, frontBackPosition);\nOdometryPosition position = OdometryCore.getInstance().getCurrentPosition(encoderPositions);\n```\nThe parameters seen are: \n- leftPosition: The left encoder's position in ticks\n- rightPosition: The right encoder's position in ticks\n- frontBackPosition: The front or back encoder's position in ticks\n\nThe position tracking code should be run on a loop with as small an interval as possible, and if possible on a separate thread\n\n## Features and Bugs\nPlease file feature requests and bugs at the [issue tracker].\n\n[issue tracker]: https://github.com/tmthecoder/OdometryCore/issues\n\n## Licensing\n\nOdometryCore is Licensed under the [MIT License] \n\n[MIT License]: https://github.com/tmthecoder/OdometryCore/blob/main/LICENSE\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftmthecoder%2Fodometrycore","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftmthecoder%2Fodometrycore","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftmthecoder%2Fodometrycore/lists"}