Change license to MIT

[jenkicar/rpp-simulink.git] / rpp / blocks / sfunction_lout.c

diff --git a/rpp/blocks/sfunction_lout.c b/rpp/blocks/sfunction_lout.c
index b390b5c1d809ced3b15897ff69149942f44fbfe3..66044c3273cabede7f83c692b9fd764529a6f76d 100644 (file)
--- a/rpp/blocks/sfunction_lout.c
+++ b/rpp/blocks/sfunction_lout.c
@@ -3,10 +3,26 @@
  * Authors:
  *     - Carlos Jenkins <carlos@jenkins.co.cr>
  *
  * Authors:
  *     - Carlos Jenkins <carlos@jenkins.co.cr>
  *

- * This document contains proprietary information belonging to Czech
- * Technical University in Prague. Passing on and copying of this
- * document, and communication of its contents is not permitted
- * without prior written authorization.
+ * Permission is hereby granted, free of charge, to any person
+ * obtaining a copy of this software and associated documentation
+ * files (the "Software"), to deal in the Software without
+ * restriction, including without limitation the rights to use,
+ * copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following
+ * conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+ * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+ * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ * OTHER DEALINGS IN THE SOFTWARE.

  *
  * File : sfunction_lout.c
  * Abstract:
  *
  * File : sfunction_lout.c
  * Abstract:


@@ -35,25 +51,27 @@ Outputs:
   - { name: "ErrFlag",          type: "bool"  }
 
 Parameters:
   - { name: "ErrFlag",          type: "bool"  }
 
 Parameters:

-  - { name: "Pin number [1-8]", type: "uint8" }
+  - { name: "Pin number", type: "uint8", range: "[1-8]" }

 
 # Description and Help is in Markdown mark-up
 
 # Description and Help is in Markdown mark-up

-Description: &desc |
+Description: |
+
+  Sends the digital value to the specified logic output pin on the RPP
+  board.
+
+  An input of 1 sets the pin high and 0 sets the pin low.
+
+  If an error is detected while setting the pin, the ErrFlag is set
+  high.
+
+Help: |

 
   This block allows to write to the digital outputs on the RPP board. The ErrFlag should raise if 
   `rpp_lout_set()` or `rpp_lout_update()` returns error. Because the ErrFlag should never set, 
   once set the following steps will never clear it back. `rpp_lout_update()` is called on each 
   block, which is not the most efficient but guaranties consistent behavior.
 
 
   This block allows to write to the digital outputs on the RPP board. The ErrFlag should raise if 
   `rpp_lout_set()` or `rpp_lout_update()` returns error. Because the ErrFlag should never set, 
   once set the following steps will never clear it back. `rpp_lout_update()` is called on each 
   block, which is not the most efficient but guaranties consistent behavior.
 

-Help: *desc
-
-Status:
-  Tested:
-    - Changing the pin.
-    - Compilation and general use.
-  Untested:
-    - Faulty situation for the ErrFlag to set.
-  Not working:
+Status: Stable

 
 RPP API functions used:
     - rpp_lout_set()
 
 RPP API functions used:
     - rpp_lout_set()