Skip to content

Commit

Permalink
README update
Browse files Browse the repository at this point in the history
  • Loading branch information
byq77 committed Jun 29, 2020
1 parent 1dc8271 commit 29bc00c
Showing 1 changed file with 18 additions and 2 deletions.
20 changes: 18 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,31 @@ Condensed, step by step recipe:

This library is compatible with Mbed CLI tools. You can change default Serial pins and baudrate used by rosserial in `mbed_app.json`.

Example:
**Available options**:

* `"rosserial-mbed.tx_pin"` - serial tx pin
* `"rosserial-mbed.rx_pin"` - serial rx pin
* `"rosserial-mbed.baudrate"` - serial baudrate
* `"rosserial-mbed.in_buffer_size"` - node input buffer size (default: 512)
* `"rosserial-mbed.out_buffer_size"` - node output buffer size (default: 512)
* `"rosserial-mbed.rtos_kernel_ms_tick"` - use kernel_ms_tick instead Ticker

`rosserial-mbed` uses `UARTSerial` library that has following configuration options:
* `"drivers.uart-serial-rxbuf-size"` - input buffer,
* `"drivers.uart-serial-txbuf-size"`- output buffer,

**Example:**

```json
{
"target_overrides":{
"*": {
"rosserial-mbed.tx_pin": "MY_TX_PIN",
"rosserial-mbed.rx_pin": "MY_RX_PIN",
"rosserial-mbed.baudrate": 230400
"rosserial-mbed.baudrate": 230400,
"drivers.uart-serial-rxbuf-size": 512,
"drivers.uart-serial-txbuf-size": 512,
"rosserial-mbed.rtos_kernel_ms_tick": 1
}
}
}
Expand Down

0 comments on commit 29bc00c

Please sign in to comment.