Browse Source

Remove deprecated `communication` options from dataflow examples, templates, and docs

tags/v0.2.3-rc
Philipp Oppermann 2 years ago
parent
commit
72a57ce1ef
Failed to extract signature
16 changed files with 12 additions and 97 deletions
  1. +0
    -4
      README.md
  2. +0
    -4
      binaries/cli/src/template/c/dataflow-template.yml
  3. +0
    -4
      binaries/cli/src/template/cxx/dataflow-template.yml
  4. +0
    -4
      binaries/cli/src/template/python/dataflow-template.yml
  5. +12
    -16
      binaries/cli/src/template/rust/dataflow-template.yml
  6. +0
    -21
      docs/src/dataflow-config.md
  7. +0
    -4
      examples/benchmark/dataflow.yml
  8. +0
    -4
      examples/c++-dataflow/dataflow.yml
  9. +0
    -4
      examples/c-dataflow/dataflow.yml
  10. +0
    -6
      examples/multiple-daemons/dataflow.yml
  11. +0
    -4
      examples/python-dataflow/dataflow.yml
  12. +0
    -4
      examples/python-dataflow/dataflow_without_webcam.yml
  13. +0
    -4
      examples/python-operator-dataflow/dataflow.yml
  14. +0
    -4
      examples/python-operator-dataflow/dataflow_without_webcam.yml
  15. +0
    -4
      examples/rust-dataflow-url/dataflow.yml
  16. +0
    -6
      examples/rust-dataflow/dataflow.yml

+ 0
- 4
README.md View File

@@ -94,10 +94,6 @@ You need to add the created operators/nodes to your dataflow YAML file.
8. You can also download already implemented operators by putting links in the dataflow. This example will launch a webcam plot stream.

```yaml
communication:
zenoh:
prefix: abc_project

nodes:
- id: op_1
operator:


+ 0
- 4
binaries/cli/src/template/c/dataflow-template.yml View File

@@ -1,7 +1,3 @@
communication:
zenoh:
prefix: ___name___

nodes:
- id: op_1
operator:


+ 0
- 4
binaries/cli/src/template/cxx/dataflow-template.yml View File

@@ -1,7 +1,3 @@
communication:
zenoh:
prefix: ___name___

nodes:
- id: runtime-node_1
operators:


+ 0
- 4
binaries/cli/src/template/python/dataflow-template.yml View File

@@ -1,7 +1,3 @@
communication:
zenoh:
prefix: ___name___

nodes:
- id: op_1
operator:


+ 12
- 16
binaries/cli/src/template/rust/dataflow-template.yml View File

@@ -1,24 +1,20 @@
communication:
zenoh:
prefix: ___name___

nodes:
- id: op_1
operator:
build: cargo build -p op_1
shared-library: target/debug/op_1
inputs:
tick: dora/timer/millis/100
outputs:
- some-output
build: cargo build -p op_1
shared-library: target/debug/op_1
inputs:
tick: dora/timer/millis/100
outputs:
- some-output
- id: op_2
operator:
build: cargo build -p op_2
shared-library: target/debug/op_2
inputs:
tick: dora/timer/secs/2
outputs:
- some-output
build: cargo build -p op_2
shared-library: target/debug/op_2
inputs:
tick: dora/timer/secs/2
outputs:
- some-output

- id: custom-node_1
custom:


+ 0
- 21
docs/src/dataflow-config.md View File

@@ -7,10 +7,6 @@ Dataflows are specified through a YAML file. This section presents our current d
Dataflows are specified through the following format:

```yaml
communication:
zenoh:
prefix: /example-python-no-webcam-dataflow

nodes:
- id: foo
# ... (see below)
@@ -103,24 +99,7 @@ Each operator must specify exactly one implementation. The implementation must f
```yaml
{{#include ../../examples/rust-dataflow/dataflow.yml}}
```
## Communication

The mandatory `communication` key specifies how dora nodes and operators should communicate with each other. Dora supports the following backends:

- **[Zenoh](https://zenoh.io/):** The zenoh project implements a distributed publisher/subscriber system with automated routing. To communicate over zenoh, add the following key to your dataflow configuration:

```yaml
communication:
zenoh:
prefix: some-unique-prefix
```

The specified `prefix` is added to all pub/sub topics. It is useful for filtering messages (e.g. in a logger) when other applications use `zenoh` in parallel. Dora will extend the given prefix with a newly generated UUID on each run, to ensure that multiple instances of the same dataflow run concurrently without interfering with each other.

Zenoh is quite flexible and can be easily scaled to distributed deployment. It does not require any extra setup since it supports peer-to-peer communication without an external broker. The drawback of zenoh is that it is still in an early stage of development, so it might still have reliability and performance issues.

_Note:_ Dora currently only supports local deployments, so interacting with remote nodes/operators is not possible yet.
## TODO: Integration with ROS 1/2

To integrate dora-rs operators with ROS1 or ROS2 operators, we plan to provide special _bridge operators_. These operators act as a sink in one dataflow framework and push all messages to a different dataflow framework, where they act as source.


+ 0
- 4
examples/benchmark/dataflow.yml View File

@@ -1,7 +1,3 @@
communication:
zenoh:
prefix: benchmark-example

nodes:
- id: rust-node
custom:


+ 0
- 4
examples/c++-dataflow/dataflow.yml View File

@@ -1,7 +1,3 @@
communication:
zenoh:
prefix: example-cxx-dataflow

nodes:
- id: cxx-node-rust-api
custom:


+ 0
- 4
examples/c-dataflow/dataflow.yml View File

@@ -1,7 +1,3 @@
communication:
zenoh:
prefix: example-c-dataflow

nodes:
- id: c_node
custom:


+ 0
- 6
examples/multiple-daemons/dataflow.yml View File

@@ -1,9 +1,3 @@
communication:
zenoh:
prefix: example-multiple-daemons

daemon_config: Tcp # or Shmem

nodes:
- id: rust-node
deploy:


+ 0
- 4
examples/python-dataflow/dataflow.yml View File

@@ -1,7 +1,3 @@
communication:
zenoh:
prefix: example-python-dataflow

nodes:
- id: webcam
custom:


+ 0
- 4
examples/python-dataflow/dataflow_without_webcam.yml View File

@@ -1,7 +1,3 @@
communication:
zenoh:
prefix: example-python-no-webcam-dataflow

nodes:
- id: no_webcam
custom:


+ 0
- 4
examples/python-operator-dataflow/dataflow.yml View File

@@ -1,7 +1,3 @@
communication:
zenoh:
prefix: example-python-dataflow

nodes:
- id: webcam
operator:


+ 0
- 4
examples/python-operator-dataflow/dataflow_without_webcam.yml View File

@@ -1,7 +1,3 @@
communication:
zenoh:
prefix: example-python-no-webcam-dataflow

nodes:
- id: no_webcam
custom:


+ 0
- 4
examples/rust-dataflow-url/dataflow.yml View File

@@ -1,7 +1,3 @@
communication:
zenoh:
prefix: example-rust-dataflow

nodes:
- id: rust-node
custom:


+ 0
- 6
examples/rust-dataflow/dataflow.yml View File

@@ -1,9 +1,3 @@
communication:
zenoh:
prefix: example-rust-dataflow

daemon_config: Tcp # or Shmem

nodes:
- id: rust-node
custom:


Loading…
Cancel
Save