]> rtime.felk.cvut.cz Git - pes-rpp/rpp-simulink.git/commitdiff
Update DIN block documentation
authorKarel Kočí <cynerd@email.cz>
Wed, 27 Aug 2014 15:23:55 +0000 (17:23 +0200)
committerMichal Sojka <sojkam1@fel.cvut.cz>
Thu, 28 Aug 2014 16:47:36 +0000 (18:47 +0200)
Added parameters description and mention about Input Configure Block.

rpp/blocks/sfunction_din.c

index 1979a8944030483218f46871ad452163a7b5069f..60c340721458387c13c423d9ca25805b1beffa39 100644 (file)
@@ -41,16 +41,23 @@ Parameters:
     type: uint8
   - name: Use variable threshold
     type: bool
+  - name: Pull
+    type: Choice from Pull-down or Pull-up
+  - name: Active
+    type: Choice from Active or Tri-stated
 
 # Description is in Markdown mark-up
 Description: >
 
-  This block allows to read the digital inputs on the RPP board. The variable threshold check change 
-  the read mode of the pin. The ErrFlag should raise if `rpp_din_update()` or `rpp_din_get()` 
-  returns error. `rpp_din_update()` is called just by the first DIN block in the model and thus 
-  only the first block could raise the flag because of this. In case an errors occurs the return 
-  value will always be LOW (0). Because the ErrFlag should never set, once set the following steps 
-  will never clear it back.
+  This block allows to read the digital inputs on the RPP board. For pins number 0-7 is not
+  relevant and not visible parameter 'Use variable threshold' and only one block for each pin
+  can be in model. And oppositely for other pins (8-15) are not relevant and visible parameters
+  of names 'Pull' and 'Active'. The variable threshold check change the read mode of the pin. For 
+  setting it see Digital Input Configure block.   
+  The ErrFlag should raise if `rpp_din_update()` or `rpp_din_get()` returns error. `rpp_din_update()` 
+  is called just by the first DIN block in the model and thus only the first block could raise the 
+  flag because of this. In case an errors occurs the return value will always be LOW (0). Because the 
+  ErrFlag should never set, once set the following steps will never clear it back.
 
 Status:
   Tested: