diff --git a/Package/python/setup.py b/Package/python/setup.py index cba9dec..afa8ff5 100644 --- a/Package/python/setup.py +++ b/Package/python/setup.py @@ -5,7 +5,7 @@ with open("./README.md", "r", encoding="utf-8") as fh: setup( name="bellande_particle", - version="0.0.1", + version="0.0.2", description="Robotics Particle", long_description=long_description, long_description_content_type="text/markdown", diff --git a/Package/rust/README.md b/Package/rust/README.md new file mode 100644 index 0000000..f9b716d --- /dev/null +++ b/Package/rust/README.md @@ -0,0 +1,241 @@ +# 📦 Bellande Particle + +## 🧙 Organization Website +- [![Organization Website](https://img.shields.io/badge/Explore%20Our-Website-0099cc?style=for-the-badge)](https://robotics-sensors.github.io) + +## 🧙 Organization Github +- [![Organization Github ](https://img.shields.io/badge/Explore%20Our-Github-0099cc?style=for-the-badge)](https://github.com/Robotics-Sensors) + +# Author, Creator and Maintainer +- **Ronaldson Bellande** + +# API HTTP Usability (BELLANDE FORMAT) +``` +# Copyright (C) 2024 Bellande Robotics Sensors Research Innovation Center, Ronaldson Bellande +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. + +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +# GNU General Public License v3.0 or later + +url: https://bellande-robotics-sensors-research-innovation-center.org + +endpoint_paths: + move: /api/Bellande_Particle/move + read_markers: /api/Bellande_Particle/read_markers + create_random: /api/Bellande_Particle/create_random + +Bellande_Framework_Access_Key: bellande_web_api_opensource +``` + +# API HTTP Usability (JSON FORMAT) +```json +{ + "license": [ + "Copyright (C) 2024 Bellande Robotics Sensors Research Innovation Center, Ronaldson Bellande", + "This program is free software: you can redistribute it and/or modify", + "it under the terms of the GNU General Public License as published by", + "the Free Software Foundation, either version 3 of the License, or", + "(at your option) any later version.", + "", + "This program is distributed in the hope that it will be useful,", + "but WITHOUT ANY WARRANTY; without even the implied warranty of", + "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the", + "GNU General Public License for more details.", + "", + "You should have received a copy of the GNU General Public License", + "along with this program. If not, see .", + "GNU General Public License v3.0 or later" + ], + "url": "https://bellande-robotics-sensors-research-innovation-center.org", + "endpoint_paths": { + "move": "/api/Bellande_Particle/move", + "read_markers": "/api/Bellande_Particle/read_markers", + "create_random": "/api/Bellande_Particle/create_random" + }, + "Bellande_Framework_Access_Key": "bellande_web_api_opensource" +} +``` + +# API Payload Examples + +## Move Particle +```json +{ + "particle": { + "x": 0, + "y": 0, + "heading": 0, + "weight": 1.0 + }, + "rotation1": 45.0, + "translation": 1.0, + "rotation2": -45.0, + "auth": { + "authorization_key": "bellande_web_api_opensource" + } +} +``` + +## Read Markers +```json +{ + "particle": { + "x": 0, + "y": 0, + "heading": 0, + "weight": 1.0 + }, + "world": { + "width": 10.0, + "height": 10.0, + "markers": [[1.0, 1.0]] + }, + "auth": { + "authorization_key": "bellande_web_api_opensource" + } +} +``` + +## Create Random +```json +{ + "count": 10, + "world": { + "width": 10.0, + "height": 10.0, + "markers": [[1.0, 1.0]] + }, + "auth": { + "authorization_key": "bellande_web_api_opensource" + } +} +``` + +# 🧙 Website Bellande API Testing +- [![Website API Testing](https://img.shields.io/badge/Bellande%20API-Testing-0099cc?style=for-the-badge)](https://bellande-robotics-sensors-research-innovation-center.org/api/bellande_particle_experiment) + +# Quick Bellande API Testing Examples + +## Move Particle +```bash +curl -X 'POST' \ + 'https://bellande-robotics-sensors-research-innovation-center.org/api/Bellande_Particle/move' \ + -H 'accept: application/json' \ + -H 'Content-Type: application/json' \ + -d '{ + "particle": { + "x": 0, + "y": 0, + "heading": 0, + "weight": 1.0 + }, + "rotation1": 45.0, + "translation": 1.0, + "rotation2": -45.0, + "auth": { + "authorization_key": "bellande_web_api_opensource" + } + }' +``` + +## Read Markers +```bash +curl -X 'POST' \ + 'https://bellande-robotics-sensors-research-innovation-center.org/api/Bellande_Particle/read_markers' \ + -H 'accept: application/json' \ + -H 'Content-Type: application/json' \ + -d '{ + "particle": { + "x": 0, + "y": 0, + "heading": 0, + "weight": 1.0 + }, + "world": { + "width": 10.0, + "height": 10.0, + "markers": [[1.0, 1.0]] + }, + "auth": { + "authorization_key": "bellande_web_api_opensource" + } + }' +``` + +## Create Random +```bash +curl -X 'POST' \ + 'https://bellande-robotics-sensors-research-innovation-center.org/api/Bellande_Particle/create_random' \ + -H 'accept: application/json' \ + -H 'Content-Type: application/json' \ + -d '{ + "count": 10, + "world": { + "width": 10.0, + "height": 10.0, + "markers": [[1.0, 1.0]] + }, + "auth": { + "authorization_key": "bellande_web_api_opensource" + } + }' +``` + +# Bellande Particle Usage + +## Website Crates +- https://crates.io/crates/bellande_particle + +### Installation +- `cargo add bellande_particle` + +## Website PYPI +- https://pypi.org/project/bellande_particle + +### Installation +- `$ pip install bellande_particle` + +### Command Line Usage Examples + +```bash +# Move particle +bellande_particle move \ + --particle-state "[0,0,0,1.0]" \ + --rotation1 45.0 \ + --translation 1.0 \ + --rotation2 -45.0 + +# Read markers +bellande_particle read-markers \ + --particle-state "[0,0,0,1.0]" \ + --world '{"width":10.0,"height":10.0,"markers":[[1.0,1.0]]}' + +# Create random particles +bellande_particle create-random \ + --count 10 \ + --world '{"width":10.0,"height":10.0,"markers":[[1.0,1.0]]}' +``` + +### Upgrade +- `$ pip install --upgrade bellande_particle` + +``` +Name: bellande_particle +Summary: A particle system using Bellande distributions for robust state estimation and localization +Home-page: github.com/Robotics-Sensors/bellande_particle +Author: Ronaldson Bellande +Author-email: ronaldsonbellande@gmail.com +License: GNU General Public License v3.0 +``` + +## License +This Algorithm or Models is distributed under the [Creative Commons Attribution-ShareAlike 4.0 International License](http://creativecommons.org/licenses/by-sa/4.0/), see [LICENSE](https://github.com/Robotics-Sensors/bellande_particle/blob/main/LICENSE) and [NOTICE](https://github.com/Robotics-Sensors/bellande_particle/blob/main/LICENSE) for more information.