X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=README.md;h=e127543f42869a00eca8e721eba3ec3a4b91f53f;hb=1e8b40f719ac43ea53e414e311d9387757630de6;hp=e1523ab47445a80d2f5fd20d154870132919074c;hpb=397b27846f0ba22d62274dd0780e6870e7a67eed;p=apps%2Fagl-service-can-low-level.git diff --git a/README.md b/README.md index e1523ab4..e127543f 100644 --- a/README.md +++ b/README.md @@ -297,11 +297,59 @@ forwarded. **Response** -If the bus and mode in the request were recognized, the `status` field in the -response will be `true`. If `false`, the passthrough mode was not changed. +If the bus in the request was valid and the passthrough mode was changed, the +`status` field in the response will be `true`. If `false`, the passthrough mode +was not changed. { "command_response": "passthrough", "status": true} +#### Acceptance Filter Bypass + +The `af_bypass` command controls whether the CAN message acceptance filter is +bypassed for each CAN controller. By default, hardware acceptance filter (AF) is +enabled in the VI - only previously defined CAN message IDs will be received. +Send this command with `bypass: true` to force the filters to bypassed. + +If `passthrough` mode is also enabled, when the AF is bypassed, the output will +include all CAN messages received. + +**Request** + + { "command": "af_bypass", + "bus": 1, + "bypass": true + } + +**Response** + +If the bus in the request was valid and the AF mode was changed, the `status` +field in the response will be `true`. If `false`, the passthrough mode was not +changed. + + { "command_response": "af_bypass", "status": true} + +#### Payload Format Control + +The `payload_format` command determines the format for output data from the VI +and the expected format of commands sent to the VI. + +Valid formats are `json` and `protobuf`. + +**Request** + + { "command": "payload_format", + "format": "json" + } + +**Response** + +If the format was changed successfully, the `status` in the response will be +`true`. The response will be in the original message format, and all subsequent +messages will be in the new format. + + { "command_response": "payload_format", "status": true} + + ### Trace File Format An OpenXC vehicle trace file is a plaintext file that contains JSON objects,