Code Monkey home page Code Monkey logo

webots-rs's Introduction

Webots controllers in Rust

Status: experimental

This is a reference project that shows how to build controllers for the Webots robot simulator using the Rust programming language.

Getting Started

  1. Download and install Webots for your operating system
  2. Install Rust if you haven't already
  3. Clone this repository
  4. Run make to compile the Rust controller and copy it into place
  5. Open the sample_project/worlds/my_first_simulation.wbt file in Webots
  6. Run the simulation

You should see "The Rust controller has started" in the Webots console.

To make changes to the controller, you can edit src/main.rs and then run make again. You might need to reset the simulation (File > Reset Simulation) or restart Webots to use the updated code.

How this works

At compile time, I use bindgen to convert a list of Webots C header files (see wrapper.h) into Rust structures and types. Those types form a bridge between the Rust-based controller code and the Webots C library that does the hard work of interacting with the simulation engine. See build.rs for more details.

Contributing

Improvements are welcome. If you have an idea, please open an issue so that we can discuss it.

TODO

  • Improve API safety. While any of the Webots C functions can be called from Rust, many are marked as unsafe due to raw pointer usage. I have started wrapping a few of them in Rust functions (see lib.rs), but this approach doesn't scale very well given the size of the API.
  • More example controllers
  • Resolve "not FFI-safe" warnings somehow

License

MIT

webots-rs's People

Contributors

acj avatar simondlevy avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.