From ff1a88dfa88d83a971a8235b429fef9a97dcaf7f Mon Sep 17 00:00:00 2001 From: Michal Sojka Date: Tue, 2 Dec 2014 06:49:37 +0100 Subject: [PATCH] doc: Update YAML blocks After changing the YAML schema, it is necessary to change this in order to compile doc without errors. Also update the description to match block masks. --- rpp/blocks/sfunction_din.c | 14 ++++++++------ rpp/blocks/sfunction_dout.c | 20 ++++++++++++-------- 2 files changed, 20 insertions(+), 14 deletions(-) diff --git a/rpp/blocks/sfunction_din.c b/rpp/blocks/sfunction_din.c index 6681fac..77c9a0b 100644 --- a/rpp/blocks/sfunction_din.c +++ b/rpp/blocks/sfunction_din.c @@ -34,18 +34,20 @@ Outputs: - { name: "Digital Input value", type: "bool" } Parameters: - { name: "Port type", type: "Choice", range: "GIOA, GIOB, NHET1" } - - { name: "Pin number", type: "int8", range: "Depends on selected port" } + - { name: "Pin number", type: "int8", range: "[0–7] (depends on selected port)" } - { name: "Input Type", type: "Choice", range: "Tri-state, Pull Up, Pull Down" } # Description is in Markdown mark-up -Description: +Description: &desc | Reads a value from a GPIO pin. The block supports GIOA, GIOB and NHET1 ports. Any pin can be configured as tri-state, pull up or pull down. -Status: - Tested: - Untested: - Not working: + It is not allowed to read from one pin by using more then one DIN blocks. + It is not allowed to use DIN and DOUT blocks together configured for one GPIO pin. + +Help: *desc + +Status: Stable RPP API functions used: - hal_gpio_pin_get_dsc diff --git a/rpp/blocks/sfunction_dout.c b/rpp/blocks/sfunction_dout.c index 6cfbc60..28fe465 100644 --- a/rpp/blocks/sfunction_dout.c +++ b/rpp/blocks/sfunction_dout.c @@ -34,21 +34,25 @@ Outputs: Parameters: - { name: "Port type", type: "Choice", range: "GIOA, GIOB, NHET1" } - - { name: "Pin number", type: "int8", range: "Depends on selected port" } - - { name: "Initial output value", type: "bool" } + - { name: "Pin number", type: "int8", range: "[0–7] (depends on selected port)" } + - { name: "Initial output value", type: "uint8", range: "[0,1]" } - { name: "Output Type", type: "Choice", range: "Open Drain, Push/Pull" } # Description is in Markdown mark-up -Description: +Description: &desc | + Writes a value to a GPIO pin. The block supports GIOA, GIOB and NHET1 ports. Any pin can be configured as open drain or push/pull and initial output value can be specified. The initial value is a value, which will appear on the pin - after gpio module is initialized and persists here until the first write. + when the GPIO module is initialized and stays there until the first + block execution. + + It is not allowed to write to one pin by using more then one DOUT blocks. + It is not allowed to use DOUT and DIN blocks on one GPIO pin. + +Help: *desc -Status: - Tested: - Untested: - Not working: +Status: Stable RPP API functions used: - hal_gpio_pin_get_dsc -- 2.39.2