bellande_particle/Package/rust/README.md

📦 Bellande Particle

🧙 Organization Website

• 

🧙 Organization Github

• 

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_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)

{
  "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_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

{
    "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

{
    "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

{
    "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

• 

Quick Bellande API Testing Examples

Move Particle

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

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

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

# 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, see LICENSE and NOTICE for more information.