Skip to content

Commit e9b0670

Browse files
authored
docs: Use new REP document URLs, document base64 encoding (#1127)
1 parent 196d402 commit e9b0670

File tree

2 files changed

+26
-4
lines changed

2 files changed

+26
-4
lines changed

QUALITY_DECLARATION.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
This document is a declaration of software quality for the `rosbridge_suite` packages, based on the guidelines in [REP-2004](https://www.ros.org/reps/rep-2004.html). The following packages are covered by this declaration:
1+
This document is a declaration of software quality for the `rosbridge_suite` packages, based on the guidelines in [REP-2004](https://reps.openrobotics.org/rep-2004/). The following packages are covered by this declaration:
22

33
- rosapi
44
- rosapi_msgs
@@ -12,7 +12,7 @@ This document is a declaration of software quality for the `rosbridge_suite` pac
1212

1313
The package `rosbridge_suite` claims to be in the **Quality Level 3** category.
1414

15-
Below are the rationales, notes, and caveats for this claim, organized by each requirement listed in the [Package Requirements for Quality Level N in REP-2004](https://www.ros.org/reps/rep-2004.html).
15+
Below are the rationales, notes, and caveats for this claim, organized by each requirement listed in the [Package Requirements for Quality Level N in REP-2004](https://reps.openrobotics.org/rep-2004/).
1616

1717
## Version Policy [1]
1818

@@ -69,10 +69,10 @@ New features are required to have tests before being added.
6969

7070
## Platform Support [6]
7171

72-
`rosbridge_suite` supports all of the tier 1 platforms as described in [REP-2000](https://www.ros.org/reps/rep-2000.html#support-tiers). Tests are currently only run against Ubuntu Linux.
72+
`rosbridge_suite` supports all of the tier 1 platforms as described in [REP-2000](https://reps.openrobotics.org/rep-2000/#support-tiers). Tests are currently only run against Ubuntu Linux.
7373

7474
## Security [7]
7575

7676
### Vulnerability Disclosure Policy [7.i]
7777

78-
This package conforms to the Vulnerability Disclosure Policy in [REP-2006](https://www.ros.org/reps/rep-2006.html).
78+
This package conforms to the Vulnerability Disclosure Policy in [REP-2006](https://reps.openrobotics.org/rep-2006/).

ROSBRIDGE_PROTOCOL.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -613,3 +613,25 @@ The meta-package will contain the following packages:
613613
tornado, a python server implementation.
614614
* **rosapi** – provides ROS services for various master API calls, such as
615615
listing all the topics, services, types currently in ROS
616+
617+
### 4.6 Data Type Encoding
618+
619+
**Base64 Encoding for JSON Byte Arrays**
620+
621+
When rosbridge sends messages containing `uint8[]` or `char[]` fields as JSON, these byte arrays are automatically encoded as base64 strings to reduce message size by approximately 60-65%.
622+
623+
For example, a message field defined as:
624+
625+
```
626+
uint8[] data = [0, 0, 0, 0]
627+
```
628+
629+
Will be transmitted as:
630+
631+
```json
632+
{
633+
"data": "AAAAAAAA"
634+
}
635+
```
636+
637+
Where the string value is the base64-encoded representation of the byte array. Byte arrays may be sent to the server as either a base64 string or a JSON list of numbers, but will be re-encoded as a base64 string before being sent to other clients.

0 commit comments

Comments
 (0)