Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Caian committed Dec 16, 2023
1 parent 571a663 commit 5059ebc
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ Supported boards are:
| `esp32dev` | `espressif32` | `arduino` | `serial` <br/> `wifi` | `colcon.meta` |
| `nanorp2040connect` | `raspberrypi` | `arduino` | `serial` <br/> `wifi_nina` | `colcon_verylowmem.meta` |
| `pico` | `raspberrypi` | `arduino` | `serial` | `colcon.meta`|
| `raspberrypi_1b` <br/> `raspberrypi_2b` <br/> `raspberrypi_3b` <br/> `raspberrypi_zero` | `linux_arm` | `wiringpi` | `socket` | `linux.meta`|

The community is encouraged to open pull request with custom use cases.

Expand All @@ -52,7 +53,7 @@ The community is encouraged to open pull request with custom use cases.
```bash
apt install -y git cmake python3-pip
```

### Platform specific requirements

#### MacOS
Expand Down Expand Up @@ -132,6 +133,15 @@ The transport can be configured with the `board_microros_transport = <transport>
set_microros_native_ethernet_transports(local_mac, local_ip, agent_ip, agent_port);
```
- `socket`
```c
const char* agent_ip = "192.168.1.113";
uint16_t agent_port = 8888;
set_microros_socket_transports(agent_ip, agent_port);
```
- `custom`
The user will need to write transport functions in app code and provide it to the micro-ROS library using [`rmw_uros_set_custom_transport()` API](https://micro.ros.org/docs/tutorials/advanced/create_custom_transports/)
Expand Down

0 comments on commit 5059ebc

Please sign in to comment.