BRSRI/bellande_particle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

latest pushes

Browse Source
This commit is contained in:
Ronaldson Bellande 2024-12-18 00:02:06 -05:00
parent 75ec88de77
commit 378a112ab5
3 changed files with 28 additions and 179 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

149
Package/rust/README.md
View File

@ -1,149 +0,0 @@
# 📦 Bellande Particles
## 🧙 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 <https://www.gnu.org/licenses/>.
# GNU General Public License v3.0 or later
url: https://bellande-robotics-sensors-research-innovation-center.org
endpoint_path:
bellande_particle: /api/Bellande_Particle/bellande_particle
Bellande_Framework_Access_Key: bellande_web_api_opensource
```
# API HTTP Usability (JSON FORMAT)
```
{
"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 <https://www.gnu.org/licenses/>.",
"GNU General Public License v3.0 or later"
],
"url": "https://bellande-robotics-sensors-research-innovation-center.org",
"endpoint_path": {
"bellande_particle": "/api/Bellande_Particle/bellande_particle"
},
"Bellande_Framework_Access_Key": "bellande_web_api_opensource"
}
```
# API Payload Example
```
{
"particle": [0, 0, 0, 1.0],
"movement": {
"rotation1": 45.0,
"translation": 1.0,
"rotation2": -45.0
},
"world": {
"width": 10.0,
"height": 10.0,
"markers": [[1.0, 1.0]]
},
"count": 10,
"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_particles_experiment)
# Quick Bellande API Testing
```
curl -X 'POST' \
'https://bellande-robotics-sensors-research-innovation-center.org/api/Bellande_Particle/bellande_particle' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"particle": [0, 0, 0, 1.0],
"movement": {
"rotation1": 45.0,
"translation": 1.0,
"rotation2": -45.0
},
"world": {
"width": 10.0,
"height": 10.0,
"markers": [[1.0, 1.0]]
},
"count": 10,
"auth": {
"authorization_key": "bellande_web_api_opensource"
}
}'
```
# Bellande Particles 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`
### Usage
```
bellande_particle \
--particle "[0, 0, 0, 1.0]" \
--movement '{"rotation1": 45.0, "translation": 1.0, "rotation2": -45.0}' \
--world '{"width": 10.0, "height": 10.0, "markers": [[1.0, 1.0]]}' \
--count 10
```
### Upgrade (if not upgraded)
- `$ 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.

29
run_api.bellos
View File

@ -1,23 +1,22 @@
curl -X 'POST' \
'https://bellande-robotics-sensors-research-innovation-center.org/api/Bellande_Limit/bellande_particle' \
'https://bellande-robotics-sensors-research-innovation-center.org/api/Bellande_Particle/bellande_particle' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"node0": [0, 0, 0],
"node1": [100, 100, 100],
"environment": [1000, 1000, 1000],
"size": [10, 10, 10],
"goal": [200, 200, 200],
"obstacles": [
{
"position": [50, 50, 50],
"dimensions": [20, 20, 20]
}
],
"search_radius": 50,
"sample_points": 20,
"particle": [0, 0, 0, 1.0],
"movement": {
"rotation1": 45.0,
"translation": 1.0,
"rotation2": -45.0
},
"world": {
"width": 10.0,
"height": 10.0,
"markers": [[1.0, 1.0]]
},
"count": 10,
"auth": {
"authorization_key": "bellande_web_api_opensource"
"authorization_key": "bellande_web_api_opensource"
}
}'
echo ""

29
run_api.sh
View File

@ -1,23 +1,22 @@
curl -X 'POST' \
'https://bellande-robotics-sensors-research-innovation-center.org/api/Bellande_Limit/bellande_particle' \
'https://bellande-robotics-sensors-research-innovation-center.org/api/Bellande_Particle/bellande_particle' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"node0": [0, 0, 0],
"node1": [100, 100, 100],
"environment": [1000, 1000, 1000],
"size": [10, 10, 10],
"goal": [200, 200, 200],
"obstacles": [
{
"position": [50, 50, 50],
"dimensions": [20, 20, 20]
}
],
"search_radius": 50,
"sample_points": 20,
"particle": [0, 0, 0, 1.0],
"movement": {
"rotation1": 45.0,
"translation": 1.0,
"rotation2": -45.0
},
"world": {
"width": 10.0,
"height": 10.0,
"markers": [[1.0, 1.0]]
},
"count": 10,
"auth": {
"authorization_key": "bellande_web_api_opensource"
"authorization_key": "bellande_web_api_opensource"
}
}'
echo ""