decide

This workspace contains crates for the behavioral experiment framework decide.

contents

• decide-protocol: protobuf definitions, error types, the Component trait, and trait implementations for transforming between tmq::Multipart messages and the types used internally
• decide-core: the main logic for initializing components and routing messages between clients and components
• components/*: crates with a type that implements decide_protocol::Component

building and running

Since this workspace only contains a single binary crate, decide-core, you can use cargo build and cargo run as normal. If you want to set feature flags (e.g. dummy-mode, see [decide-core/src/lib.rs] for details), you can pass them from the command line, like cargo run --features dummy-mode.

To compile for a specific architecture (Beaglebone Black, in our case), use cross (requires docker or podman):

cargo install cross
cross build --target armv7-unknown-linux-gnueabihf --release

logging

Logging level defaults to INFO, but can be overwritten with export DECIDE_LOG="value"

adding components

1. Design component as a separate crate ("package") under ./components/ according to the protocol. Follow ./components/lights as an example.
2. Include component crate in decide-core dependencies (./decide-core/Cargo.toml).
3. Import Component-implemented struct and add to list of components in impl_components! macro in ./decide-core/src/components.rs
4. Include component crate in the main cargo manifest (./Cargo.toml)

running tests

The tests require a running instance of decide, otherwise they will hang.

mkdir -p ~/.config/decide/
ln -s components/lights/tests/components.yml ~/.config/decide/
cargo run &
cargo test
kill $(jobs -l -p)