17 unstable releases (5 breaking)

0.6.3 Feb 7, 2024
0.6.0 Dec 18, 2023
0.5.0 Nov 26, 2023
0.4.9 Aug 18, 2022
0.3.8 Jul 25, 2022

#9 in Robotics

Download history 2/week @ 2024-02-13 41/week @ 2024-02-20 47/week @ 2024-02-27 1/week @ 2024-03-05 6/week @ 2024-03-12 5/week @ 2024-03-26 37/week @ 2024-04-02 7/week @ 2024-04-09 4/week @ 2024-04-23

186 downloads per month

MIT license

66KB
1K SLoC

Bonsai 盆栽

Rust implementation of Behavior Trees

Build Status Bonsai crate minimum rustc 1.56 Docs codecov Maintenance GitHub pull-requests GitHub pull-requests closed ViewCount License: MIT

Contents

Using Bonsai

Bonsai is available on crates.io. The recommended way to use it is to add a line into your Cargo.toml such as:

[dependencies]
bonsai-bt = "*"

What is a Behavior Tree?

A Behavior Tree (BT) is a data structure in which we can set the rules of how certain behavior's can occur, and the order in which they would execute. BTs are a very efficient way of creating complex systems that are both modular and reactive. These properties are crucial in many applications, which has led to the spread of BT from computer game programming to many branches of AI and Robotics.

How to use a Behavior tree?

A Behavior Tree forms a tree structure where each node represents a process. When the process terminates, it signals Success or Failure. This can then be used by the parent node to select the next process. A signal Running is used to tell the process is not done yet.

For example, if you have a state A and a state B:

  • Move from state A to state B if A succeeds: Sequence([A, B])
  • Move from state A to sequence of states [B] if A is running. If all states in the sequence [B] succeed in order, check if A is still running and repeat. Stop if A succeeds or any of the states fail: RepeatSequence(A, [B])
  • Try A first and then try B if A fails: Select([A, B])
  • If condition succeedes do A, else do B : If(condition, A, B)
  • If A succeeds, return failure (and vice-versa): Invert(A)
  • Do B repeatedly while A runs: While(A, [B])
  • Do A, B forever: While(WaitForever, [A, B])
  • Run A and B in parallell and wait for both to succeed: WhenAll([A, B])
  • Run A and B in parallell and wait for any to succeed: WhenAny([A, B])
  • Run A and B in parallell, but A has to succeed before B: After([A, B])

See the Behavior enum for more information.

Calling long-running tasks in behavior tree

To make sure that the behavior tree is always responsive, it is important that the actions that are created executes instantly so that they do not block the tree traversal. If you have long-running tasks/functions that can take seconds or minutes to execute - either async or sync - then we can dispatch those jobs into background threads, and get status of the task through a channel.

see async drone example in the /examples folder for more details.

Example of use

See Examples folder.

Similar Crates

Bonsai is inspired by many other crates out there, here's a few worth mentioning:

Dependencies

~2.5–3.5MB
~62K SLoC