summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRomain Forlot <romain.forlot@iot.bzh>2017-03-22 08:29:24 +0000
committerRomain Forlot <romain.forlot@iot.bzh>2017-03-22 08:29:43 +0000
commit71263838ac1b62e65cf65b5e7e9105b69f71bcd5 (patch)
treecb52aa725f0cc5c99d153323f87adfcc12f909aa
parentaec5f7ddb8f9931e4a65b49949e518c40eda6507 (diff)
Specification of defaults available decoder.
Change-Id: Ifde336309bd6358ee20bd8c45a06daf5ba3329c0 Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
-rw-r--r--docs/2-Installation.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/2-Installation.md b/docs/2-Installation.md
index 410bc4b..252f8b3 100644
--- a/docs/2-Installation.md
+++ b/docs/2-Installation.md
@@ -94,6 +94,14 @@ engine.torque
>
> This described in the below chapter.
+### Available decoder
+
+You can use some basic decoder provided by default by the binding which are:
+
+* decoder_t::noopDecoder : Default decoder if not specified, return raw value from signal's bitfield.
+* decoder_t::booleanDecoder : Coerces a numerical value to a boolean.
+* decoder_t::stateDecoder : Find and return the corresponding string state for a CAN signal's raw integer value.
+
### Generating JSON from Vector CANoe Database
> **CAUTION** This chapter has not been tested since we haven't necessary automotive tools for that.