Michal Horn [Thu, 4 Dec 2014 06:39:49 +0000 (07:39 +0100)]
Add complex demo
The demo contains rotating LED controlled by FSM for DOUT demonstration,
switching of the direction of the rotation by button for DIN demonstration,\
simulation of the button by a CAN message for CAN RX demonstration,
Sending the LED state as a CAN message to demonstrate CAN TX,
some printing on the Serial Interface.
Michal Horn [Wed, 3 Dec 2014 15:28:27 +0000 (16:28 +0100)]
Update block masks by running rpp_update_doc.m
Changelog:
Processing rpp_lib/Analog Input (AIN)
--- sfunction_ain.Name.old 2014-12-03 16:28:20.916012783 +0100
+++ sfunction_ain.Name.new 2014-12-03 16:28:20.916012783 +0100
@@ -1 +1 @@
-Analog Input (AIN)
\ Chybí znak konce řádku na konci souboru
+Analog Input
\ Chybí znak konce řádku na konci souboru
Processing rpp_lib/CAN Receive
Processing rpp_lib/CAN Setup
Processing rpp_lib/CAN Transmit
Processing rpp_lib/Digital Input (DIN)
--- sfunction_din.MaskType.old 2014-12-03 16:28:22.184012808 +0100
+++ sfunction_din.MaskType.new 2014-12-03 16:28:22.184012808 +0100
@@ -1 +1 @@
-RPP Digital input
\ Chybí znak konce řádku na konci souboru
+RPP Digital Input
\ Chybí znak konce řádku na konci souboru
--- sfunction_din.MaskPromptString.old 2014-12-03 16:28:22.344012811 +0100
+++ sfunction_din.MaskPromptString.new 2014-12-03 16:28:22.344012811 +0100
@@ -1 +1 @@
-Port type:|Pin [0-7]|Input Type:
\ Chybí znak konce řádku na konci souboru
+Port type:|Pin number [0–7]:|Input Type:
\ Chybí znak konce řádku na konci souboru
--- sfunction_din.Name.old 2014-12-03 16:28:22.508012815 +0100
+++ sfunction_din.Name.new 2014-12-03 16:28:22.508012815 +0100
@@ -1 +1 @@
-Digital Input (DIN)
\ Chybí znak konce řádku na konci souboru
+Digital Input
\ Chybí znak konce řádku na konci souboru
Processing rpp_lib/Digital Output (DOUT)
--- sfunction_dout.MaskType.old 2014-12-03 16:28:22.600012816 +0100
+++ sfunction_dout.MaskType.new 2014-12-03 16:28:22.600012816 +0100
@@ -1 +1 @@
-RPP Digital output
\ Chybí znak konce řádku na konci souboru
+RPP Digital Output
\ Chybí znak konce řádku na konci souboru
--- sfunction_dout.MaskPromptString.old 2014-12-03 16:28:22.760012820 +0100
+++ sfunction_dout.MaskPromptString.new 2014-12-03 16:28:22.760012820 +0100
@@ -1 +1 @@
-Port type:|Pin [0-7]|Initial output value [0,1]:|Output Type:
\ Chybí znak konce řádku na konci souboru
+Port type:|Pin number [0–7]:|Initial output value [0,1]:|Output Type:
\ Chybí znak konce řádku na konci souboru
--- sfunction_dout.Name.old 2014-12-03 16:28:22.932012823 +0100
+++ sfunction_dout.Name.new 2014-12-03 16:28:22.932012823 +0100
@@ -1 +1 @@
-Digital Output (DOUT)
\ Chybí znak konce řádku na konci souboru
+Digital Output
\ Chybí znak konce řádku na konci souboru
Processing rpp_lib/Overrun Detection
Processing rpp_lib/Serial Configure
--- sfunction_scic.MaskType.old 2014-12-03 16:28:23.380012832 +0100
+++ sfunction_scic.MaskType.new 2014-12-03 16:28:23.380012832 +0100
@@ -1 +1 @@
-RPP Serial Communication Interface Configuration
\ Chybí znak konce řádku na konci souboru
+RPP Serial Configure
\ Chybí znak konce řádku na konci souboru
Processing rpp_lib/Serial Printf
--- sfunction_scip.MaskType.old 2014-12-03 16:28:23.756012840 +0100
+++ sfunction_scip.MaskType.new 2014-12-03 16:28:23.756012840 +0100
@@ -1 +1 @@
-RPP Serial Communication Interface Printf
\ Chybí znak konce řádku na konci souboru
+RPP Serial Printf
\ Chybí znak konce řádku na konci souboru
Processing rpp_lib/Serial Receive
--- sfunction_scir.MaskType.old 2014-12-03 16:28:24.152012848 +0100
+++ sfunction_scir.MaskType.new 2014-12-03 16:28:24.152012848 +0100
@@ -1 +1 @@
-RPP Serial Communication Interface Receive
\ Chybí znak konce řádku na konci souboru
+RPP Serial Receive
\ Chybí znak konce řádku na konci souboru
Processing rpp_lib/Serial Send
--- sfunction_scis.MaskType.old 2014-12-03 16:28:24.524012855 +0100
+++ sfunction_scis.MaskType.new 2014-12-03 16:28:24.524012855 +0100
@@ -1 +1 @@
-RPP Serial Communication Interface Send
\ Chybí znak konce řádku na konci souboru
+RPP Serial Send
\ Chybí znak konce řádku na konci souboru
[\bWarning: an error occurred while parsing class fxptui.explorer:
Invalid data type.
]\b
Michal Sojka [Tue, 2 Dec 2014 06:43:32 +0000 (07:43 +0100)]
Update rpp_lib masks by running rpp_update_doc
The diff between old and new content, produced by `make diff-doc` is
below:
Processing rpp_lib/Analog Input (AIN)
rpp_lib/Analog Input (AIN): MaskDescription not up-to-date
--- sfunction_ain.MaskDescription.old 2014-12-02 07:42:55.995932632 +0100
+++ sfunction_ain.MaskDescription.new 2014-12-02 07:42:55.995932632 +0100
@@ -1,5 +1,3 @@
-Gets the analog value of the specified analog input pin on the RPP board.
-
-The value is an unsigned 16 bit integer between 0-4095 (12 bit ADC).
-
-If an error is detected while getting the value, the ErrFlag is set high.
\ No newline at end of file
+<p>Gets the analog value of the specified analog input pin on the RPP board.</p>
+<p>The value is an unsigned 16 bit integer between 0–4095 (12 bit ADC).</p>
+<p>If an error is detected while reading the value, the ErrFlag is set high.</p>
rpp_lib/Analog Input (AIN): MaskPromptString not up-to-date
--- sfunction_ain.MaskPromptString.old 2014-12-02 07:42:56.075931344 +0100
+++ sfunction_ain.MaskPromptString.new 2014-12-02 07:42:56.075931344 +0100
@@ -1 +1 @@
-Pin number [1-16]:
\ No newline at end of file
+Pin number [1–16]:
\ No newline at end of file
rpp_lib/Analog Input (AIN): MaskHelp not up-to-date
--- sfunction_ain.MaskHelp.old 2014-12-02 07:42:56.147930187 +0100
+++ sfunction_ain.MaskHelp.new 2014-12-02 07:42:56.147930187 +0100
@@ -1,2 +1 @@
-<p>This block calls the rpp_ain_get() function from the RPP library.</p>
-<p>For more information refer to the HTML RPP library API</p>
\ No newline at end of file
+<p>This block allows to read the analog inputs on the RPP board. The ErrFlag should if raise <code>rpp_adc_update()</code> or <code>rpp_adc_get()</code> returns error. <code>rpp_adc_update()</code> 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 error occurs the return value will always be 0. Because the ErrFlag should never set, once set the following steps will never clear it back.</p>
Processing rpp_lib/CAN Receive
rpp_lib/CAN Receive: MaskType not up-to-date
--- sfunction_canreceive.MaskType.old 2014-12-02 07:42:56.219929021 +0100
+++ sfunction_canreceive.MaskType.new 2014-12-02 07:42:56.219929021 +0100
@@ -1 +1 @@
-RPP CAN bus receive message
\ No newline at end of file
+RPP CAN Receive
\ No newline at end of file
rpp_lib/CAN Receive: MaskDescription not up-to-date
--- sfunction_canreceive.MaskDescription.old 2014-12-02 07:42:56.299927738 +0100
+++ sfunction_canreceive.MaskDescription.new 2014-12-02 07:42:56.299927738 +0100
@@ -1,7 +1,6 @@
<p>Receive a messages from the CAN bus.</p>
<p>The output can be a uint8, uint16, uint32 number or CAN_MESSAGE object. CAN Unpack block can be used to unpack the data from CAN_MESSAGE object.</p>
<p>A Function-call subsystem is triggered every time when a new message has been received.</p>
-<p>When Mixed is selected in the <i>Message type</i>, the block is able to receive both, the mesages with Standard and Extended identifier.<br>
-<b>NOTE:</b> When Mixed is selected, the <i>Message ID</i> and eventualy the <i>Message ID mask</i> have to be shifted by 18 bits to the left.</p>
-<p>If the <i>Message filter</i> is set to Single ID, only the messages with the one identifier specified in <i>Message ID</i> will be accepted by the block. But when ID & mask is selected, all messages with identifier compliant to logical AND of the <i>Message ID</i> and <i>Message ID mask</i> will be accepted.</p>
-<p>Uncheck <i>Automatic mailbox number</i>, if user defined mailbox number is needed.<br>
\ No newline at end of file
+<p>When Mixed is selected in the <em>Message type</em>, the block is able to receive both, the mesages with Standard and Extended identifier.<br /><strong>NOTE:</strong> When Mixed is selected, the <em>Message ID</em> and eventualy the <em>Message ID mask</em> have to be shifted by 18 bits to the left.</p>
+<p>If the <em>Message filter</em> is set to Single ID, only the messages with the one identifier specified in <em>Message ID</em> will be accepted by the block. But when ID & mask is selected, all messages with identifier compliant to logical AND of the <em>Message ID</em> and <em>Message ID mask</em> will be accepted.</p>
+<p>Uncheck <em>Automatic mailbox number</em>, if user defined mailbox number is needed.</p>
rpp_lib/CAN Receive: MaskPromptString not up-to-date
--- sfunction_canreceive.MaskPromptString.old 2014-12-02 07:42:56.367926639 +0100
+++ sfunction_canreceive.MaskPromptString.new 2014-12-02 07:42:56.367926639 +0100
@@ -1 +1 @@
-Module|Frame type|Message ID filter|Message ID|Message ID mask|Data type|Automatic mailbox number|Mailbox number (1-64)
\ No newline at end of file
+Module:|Frame type:|Message ID filter:|Message ID:|Message ID mask:|Data type:|Automatic mailbox number|Mailbox number [1-64]:
\ No newline at end of file
rpp_lib/CAN Receive: MaskHelp not up-to-date
--- sfunction_canreceive.MaskHelp.old 2014-12-02 07:42:56.451925290 +0100
+++ sfunction_canreceive.MaskHelp.new 2014-12-02 07:42:56.451925290 +0100
@@ -1,2 +1,6 @@
-<p>This block calls the rpp_can_read() function from the RPP library.</p>
-<p>For more information refer to the HTML RPP library API</p>
\ No newline at end of file
+<p>This block allows receiving messages from the CAN bus. It can be configured for any of the CAN ports (modules) CAN1, CAN2 or CAN3.</p>
+<p>The acceptance rules for message reception can be specified by a <em>Message ID</em> parameter and optionally by a <em>Message ID mask</em>. Specifying the mask allows to receive messages with multiple IDs. The block supports both, the Standard (11b ID) and the Extended (29b ID) frame formats. Note that if Mixed message ID type is selected, the blocks will receive both frame types, but the Standard Message ID and optionally the Message ID mask has to be shifted by 18 bits to the left to correspond with the extended IDs and masks. For example, if Message ID parameter is set to 0x80000 and mask to 0x1ffbfff, the block will receive SFF messages with IDs 0x002 and 0x003 and EFF IDs 0x00080000 and 0x000c0000.</p>
+<p>The mailbox number can be assigned automatically or manually. Automatic mailbox numbers are generated in ascending order from 0 to 31. Every mailbox must have a unique number. It is possible to mix blocks with automatically and manually assigned mailboxes. If the manually assigned mailbox number would collide with the automatic one then the automatically generated block will get assigned a next higher non-colliding ID. The mailbox numbers are shared between CAN Transmit and CAN Receive blocks with the same CAN port (module) parameter.</p>
+<p>The output of this block is a message data in selected format: uint8, uint16, uint32 or CAN_MESSAGE. The CAN_MESSAGE object can be unpacked by <code>CAN Unpack</code> block.</p>
+<p>Every time a message is received, the function call on <code>f()</code> output signal is triggered and the received message data is appears on the <code>Msg</code> output port. See <code>cantransmit.slx</code> demo for examples of different configurations and the usage of the CAN blocks.</p>
+<p>In order to use this block, there must be a <code>CAN Configure</code> block in the model.</p>
Processing rpp_lib/CAN Setup
rpp_lib/CAN Setup: MaskType not up-to-date
--- sfunction_cansetup.MaskType.old 2014-12-02 07:42:56.519924191 +0100
+++ sfunction_cansetup.MaskType.new 2014-12-02 07:42:56.519924191 +0100
@@ -1 +1 @@
-RPP CAN setup
\ No newline at end of file
+RPP CAN Setup
\ No newline at end of file
rpp_lib/CAN Setup: MaskDescription not up-to-date
--- sfunction_cansetup.MaskDescription.old 2014-12-02 07:42:56.595922968 +0100
+++ sfunction_cansetup.MaskDescription.new 2014-12-02 07:42:56.595922968 +0100
@@ -1 +1 @@
-Configure CAN bus communication baud rates for every CAN modul. Default value is 500kb/sec.
\ No newline at end of file
+<p>This block configures the CAN bus controllers. Exactly one CAN bus configuration block must be in the model if any of the CAN Receive or CAN Transmit block is used.</p>
rpp_lib/CAN Setup: MaskPromptString not up-to-date
--- sfunction_cansetup.MaskPromptString.old 2014-12-02 07:42:56.659921938 +0100
+++ sfunction_cansetup.MaskPromptString.new 2014-12-02 07:42:56.659921938 +0100
@@ -1 +1 @@
-CAN1 Baudrate (1-1000000 bits/sec)|CAN2 Baudrate (1-1000000 bits/sec)|CAN3 Baudrate (1-1000000 bits/sec)
\ No newline at end of file
+CAN1 baud rate in bps 1 – 10000000:|CAN2 baud rate in bps 1 – 10000000:|CAN3 baud rate in bps 1 – 10000000:
\ No newline at end of file
rpp_lib/CAN Setup: MaskHelp not up-to-date
--- sfunction_cansetup.MaskHelp.old 2014-12-02 07:42:56.731920776 +0100
+++ sfunction_cansetup.MaskHelp.new 2014-12-02 07:42:56.731920776 +0100
@@ -1,2 +1 @@
-<p>This block resets the CAN bus drivers chips and calls the rpp_can_init() function from the RPP library.</p>
-<p>For more information refer to the HTML RPP library API</p>
\ No newline at end of file
+<p>This block configures the CAN bus controllers. Exactly one CAN bus configuration block must be in the model if any of the CAN Receive or CAN Transmit block is used.</p>
Processing rpp_lib/CAN Transmit
rpp_lib/CAN Transmit: MaskType not up-to-date
--- sfunction_cantransmit.MaskType.old 2014-12-02 07:42:56.799919678 +0100
+++ sfunction_cantransmit.MaskType.new 2014-12-02 07:42:56.799919678 +0100
@@ -1 +1 @@
-RPP CAN bus transmit a message
\ No newline at end of file
+RPP CAN Transmit
\ No newline at end of file
rpp_lib/CAN Transmit: MaskDescription not up-to-date
--- sfunction_cantransmit.MaskDescription.old 2014-12-02 07:42:56.875918460 +0100
+++ sfunction_cantransmit.MaskDescription.new 2014-12-02 07:42:56.875918460 +0100
@@ -1,4 +1,4 @@
<p>Transmit a CAN message.</p>
<p>Expects a uint8, uint16, uint32 or CAN_MESSAGE object as an input. Use CAN Pack to create the CAN_MESSAGE object.</p>
<p>Matlab expression can be used as Message ID and Mailbox number.</p>
-<p>Uncheck <i>Automatic mailbox number</i>, if user defined mailbox number is needed.<br>
\ No newline at end of file
+<p>Uncheck <em>Automatic mailbox number</em>, if user defined mailbox number is needed.</p>
rpp_lib/CAN Transmit: MaskPromptString not up-to-date
--- sfunction_cantransmit.MaskPromptString.old 2014-12-02 07:42:56.943917363 +0100
+++ sfunction_cantransmit.MaskPromptString.new 2014-12-02 07:42:56.943917363 +0100
@@ -1 +1 @@
-Module|Frame type|Message ID|Automatic mailbox number|Mailbox number (1-64)
\ No newline at end of file
+Module:|Frame type:|Message ID:|Automatic mailbox number|Mailbox number [1–64]:
\ No newline at end of file
rpp_lib/CAN Transmit: MaskHelp not up-to-date
--- sfunction_cantransmit.MaskHelp.old 2014-12-02 07:42:57.019916135 +0100
+++ sfunction_cantransmit.MaskHelp.new 2014-12-02 07:42:57.019916135 +0100
@@ -1,2 +1,5 @@
-<p>This block calls the rpp_can_write() function from the RPP library.</p>
-<p>For more information refer to the HTML RPP library API</p>
\ No newline at end of file
+<p>This block allows to send a message to the CAN bus. It can be configured for any of the CAN ports (modules) CAN1, CAN2 or CAN3.</p>
+<p>The message data are read from <code>Msg</code> input port. The data type is decided automatically from the input, but it is restricted to uint8, uint16, uint32 and CAN_MESSAGE. The CAN_MESSAGE object can be created by the <code>CAN Pack</code> block.</p>
+<p>The message sent by the block will have an ID assigned according to the number in the <em>Message ID</em> parameter. The block supports both types of message IDs: Standard (11b) and Extended (29b). If CAN_MESSAGE is used as input type, the message ID stored in CAN_MESSAGE object is ignored and the ID from the parameter of this block is used instead.</p>
+<p>The mailbox number can be assigned automatically or manually. Automatic mailbox numbers are generated in ascending order from 0 to 31. Every mailbox must have a unique number. It is possible to mix blocks with automatically and manually assigned mailboxes. If the manually assigned mailbox number would collide with the automatic one then the automatically generated block will get assigned a next higher non-colliding ID. The mailbox numbers are shared between CAN Transmit and CAN Receive blocks with the same CAN port (module) parameter.</p>
+<p>In order to use this block, there must be a <code>CAN Configure</code> block in the model.</p>
Processing rpp_lib/Digital Input (DIN)
rpp_lib/Digital Input (DIN): MaskType not up-to-date
--- sfunction_din.MaskType.old 2014-12-02 07:42:57.087915041 +0100
+++ sfunction_din.MaskType.new 2014-12-02 07:42:57.087915041 +0100
@@ -1 +1 @@
-RPP DIN
\ No newline at end of file
+RPP Digital input
\ No newline at end of file
rpp_lib/Digital Input (DIN): MaskDescription not up-to-date
--- sfunction_din.MaskDescription.old 2014-12-02 07:42:57.159913875 +0100
+++ sfunction_din.MaskDescription.new 2014-12-02 07:42:57.159913875 +0100
@@ -1,5 +1,2 @@
-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.
-
-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.
\ No newline at end of file
+<p>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.</p>
+<p>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.</p>
rpp_lib/Digital Input (DIN): MaskPromptString not up-to-date
--- sfunction_din.MaskPromptString.old 2014-12-02 07:42:57.227912780 +0100
+++ sfunction_din.MaskPromptString.new 2014-12-02 07:42:57.227912780 +0100
@@ -1 +1 @@
-Port|Pin [0-7]|Input type
\ No newline at end of file
+Port type:|Pin number [0–7] (depends on selected port):|Input Type:
\ No newline at end of file
rpp_lib/Digital Input (DIN): MaskHelp not up-to-date
--- sfunction_din.MaskHelp.old 2014-12-02 07:42:57.299911618 +0100
+++ sfunction_din.MaskHelp.new 2014-12-02 07:42:57.299911618 +0100
@@ -1 +1,2 @@
-<p>This block configures the GPIO pin by calling hal_gpio_pin_conf_set(), retrieves the descriptor of the pin by calling hal_gpio_pin_get_dsc() and reads from the pin by calling hal_gpio_pin_get_value().</p>
\ No newline at end of file
+<p>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.</p>
+<p>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.</p>
Processing rpp_lib/Digital Output (DOUT)
rpp_lib/Digital Output (DOUT): MaskType not up-to-date
--- sfunction_dout.MaskType.old 2014-12-02 07:42:57.367910521 +0100
+++ sfunction_dout.MaskType.new 2014-12-02 07:42:57.367910521 +0100
@@ -1 +1 @@
-RPP DOUT
\ No newline at end of file
+RPP Digital output
\ No newline at end of file
rpp_lib/Digital Output (DOUT): MaskDescription not up-to-date
--- sfunction_dout.MaskDescription.old 2014-12-02 07:42:57.443909294 +0100
+++ sfunction_dout.MaskDescription.new 2014-12-02 07:42:57.443909294 +0100
@@ -1,7 +1,2 @@
-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.
-
-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.
\ No newline at end of file
+<p>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 when the GPIO module is initialized and stays there until the first block execution.</p>
+<p>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.</p>
rpp_lib/Digital Output (DOUT): MaskPromptString not up-to-date
--- sfunction_dout.MaskPromptString.old 2014-12-02 07:42:57.507908260 +0100
+++ sfunction_dout.MaskPromptString.new 2014-12-02 07:42:57.507908260 +0100
@@ -1 +1 @@
-Port|Pin [0-7]|Initial output value [0-1]|Configuration
\ No newline at end of file
+Port type:|Pin number [0–7] (depends on selected port):|Initial output value [0,1]:|Output Type:
\ No newline at end of file
rpp_lib/Digital Output (DOUT): MaskHelp not up-to-date
--- sfunction_dout.MaskHelp.old 2014-12-02 07:42:57.579907099 +0100
+++ sfunction_dout.MaskHelp.new 2014-12-02 07:42:57.579907099 +0100
@@ -1 +1,2 @@
-<p>This block configures the GPIO pin by calling hal_gpio_pin_conf_set(), retrieves the descriptor of the pin by calling hal_gpio_pin_get_dsc() and writes to the pin by calling hal_gpio_pin_set_value().</p>
+<p>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 when the GPIO module is initialized and stays there until the first block execution.</p>
+<p>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.</p>
Processing rpp_lib/Overrun Detection
rpp_lib/Overrun Detection: MaskType not up-to-date
--- sfunction_tror.MaskType.old 2014-12-02 07:42:57.643906066 +0100
+++ sfunction_tror.MaskType.new 2014-12-02 07:42:57.643906066 +0100
@@ -1 +1 @@
-Overrun detection
\ No newline at end of file
+RPP Overrun Detection
\ No newline at end of file
rpp_lib/Overrun Detection: MaskDescription not up-to-date
--- sfunction_tror.MaskDescription.old 2014-12-02 07:42:57.715904904 +0100
+++ sfunction_tror.MaskDescription.new 2014-12-02 07:42:57.715904904 +0100
@@ -1 +1 @@
-Connected function subsystem is executed when overrun is detected.
\ No newline at end of file
+<p>This block triggers the connected function subsystems in case of overrun, i.e. when execution of the previous loop iteration took more time than the sampling period.</p>
rpp_lib/Overrun Detection: MaskHelp not up-to-date
--- sfunction_tror.MaskHelp.old 2014-12-02 07:42:57.843902839 +0100
+++ sfunction_tror.MaskHelp.new 2014-12-02 07:42:57.843902839 +0100
@@ -1 +1 @@
-<p>This block triggers connected simulink function subsystems in case that previous loop took more time than simulation time is set.</p>
\ No newline at end of file
+<p>This block triggers the connected function subsystems in case of overrun, i.e. when execution of the previous loop iteration took more time than the sampling period.</p>
Processing rpp_lib/Serial Configure
rpp_lib/Serial Configure: MaskDescription not up-to-date
--- sfunction_scic.MaskDescription.old 2014-12-02 07:42:57.971900773 +0100
+++ sfunction_scic.MaskDescription.new 2014-12-02 07:42:57.971900773 +0100
@@ -1 +1 @@
-Configure Serial Communication Interface baud rate. Default is 9600.
\ No newline at end of file
+<p>This block configures the baud rate of the Serial Communication Interface (SCI). Only one block of this type per model is alloved.</p>
rpp_lib/Serial Configure: MaskHelp not up-to-date
--- sfunction_scic.MaskHelp.old 2014-12-02 07:42:58.099898703 +0100
+++ sfunction_scic.MaskHelp.new 2014-12-02 07:42:58.099898703 +0100
@@ -1,2 +1 @@
-<p>This block calls the rpp_sci_setup() function from the RPP library.</p>
-<p>For more information refer to the HTML RPP library API</p>
\ No newline at end of file
+<p>This block configures the baud rate of the Serial Communication Interface (SCI). Only one block of this type per model is alloved.</p>
Processing rpp_lib/Serial Printf
rpp_lib/Serial Printf: MaskDescription not up-to-date
--- sfunction_scip.MaskDescription.old 2014-12-02 07:42:58.235896508 +0100
+++ sfunction_scip.MaskDescription.new 2014-12-02 07:42:58.235896508 +0100
@@ -1 +1,2 @@
-Printf through the Serial Communication Interface.
\ No newline at end of file
+<p>This block prints a formatted string to the SCI. The <em>Print format</em> parameter is used as the format specifier for C <code>printf()</code> function. Note that this value is inserted raw between the quotes during code generation and thus there is no validation on it. User should always put a valid specifier for the input type of the block.</p>
+<p>Due to Simulink limitations, it is not posible join diferent types into one vector. So one block can be used only for one type of inputs.</p>
rpp_lib/Serial Printf: MaskPromptString not up-to-date
--- sfunction_scip.MaskPromptString.old 2014-12-02 07:42:58.299895470 +0100
+++ sfunction_scip.MaskPromptString.new 2014-12-02 07:42:58.299895470 +0100
@@ -1 +1 @@
-Printf format (must include specifier for arguments):
\ No newline at end of file
+Print format:
\ No newline at end of file
rpp_lib/Serial Printf: MaskHelp not up-to-date
--- sfunction_scip.MaskHelp.old 2014-12-02 07:42:58.375894242 +0100
+++ sfunction_scip.MaskHelp.new 2014-12-02 07:42:58.375894242 +0100
@@ -1,2 +1,2 @@
-<p>This block calls the rpp_sci_printf() functions from the RPP library.</p>
-<p>For more information refer to the HTML RPP library API</p>
\ No newline at end of file
+<p>This block prints a formatted string to the SCI. The <em>Print format</em> parameter is used as the format specifier for C <code>printf()</code> function. Note that this value is inserted raw between the quotes during code generation and thus there is no validation on it. User should always put a valid specifier for the input type of the block.</p>
+<p>Due to Simulink limitations, it is not posible join diferent types into one vector. So one block can be used only for one type of inputs.</p>
Processing rpp_lib/Serial Receive
rpp_lib/Serial Receive: MaskDescription not up-to-date
--- sfunction_scir.MaskDescription.old 2014-12-02 07:42:58.507892106 +0100
+++ sfunction_scir.MaskDescription.new 2014-12-02 07:42:58.507892106 +0100
@@ -1 +1 @@
-Reads one byte from the Serial Communication Interface.
\ No newline at end of file
+<p>This block receives a byte from the SCI by calling <code>rpp_sci_read_nb()</code>. The ErrFlag raises if the call returns an error. The behavior of the ErrFlag is different from others blocks in that this block will set or clear the flag in each step depending on the result. Note that this block uses a non-blocking function to read the SCI and thus it will work even if nothing is received.</p>
rpp_lib/Serial Receive: MaskHelp not up-to-date
--- sfunction_scir.MaskHelp.old 2014-12-02 07:42:58.635890038 +0100
+++ sfunction_scir.MaskHelp.new 2014-12-02 07:42:58.635890038 +0100
@@ -1,2 +1 @@
-<p>This block calls the rpp_sci_read() function from the RPP library if data is available (rpp_sci_available()).</p>
-<p>For more information refer to the HTML RPP library API</p>
\ No newline at end of file
+<p>This block receives a byte from the SCI by calling <code>rpp_sci_read_nb()</code>. The ErrFlag raises if the call returns an error. The behavior of the ErrFlag is different from others blocks in that this block will set or clear the flag in each step depending on the result. Note that this block uses a non-blocking function to read the SCI and thus it will work even if nothing is received.</p>
Processing rpp_lib/Serial Send
rpp_lib/Serial Send: MaskDescription not up-to-date
--- sfunction_scis.MaskDescription.old 2014-12-02 07:42:58.767887904 +0100
+++ sfunction_scis.MaskDescription.new 2014-12-02 07:42:58.767887904 +0100
@@ -1 +1,2 @@
-Sends one byte through the Serial Communication Interface.
\ No newline at end of file
+<p>This block sends a byte to the SCI.</p>
+<p>The ErrFlag is set to true <code>rpp_sci_write_nb()</code> returns an error, to false otherwise.</p>
rpp_lib/Serial Send: MaskHelp not up-to-date
--- sfunction_scis.MaskHelp.old 2014-12-02 07:42:58.895885837 +0100
+++ sfunction_scis.MaskHelp.new 2014-12-02 07:42:58.895885837 +0100
@@ -1,2 +1,2 @@
-<p>This block calls the rpp_sci_write_nb() or rpp_sci_printf() functions from the RPP library.</p>
-<p>For more information refer to the HTML RPP library API</p>
\ No newline at end of file
+<p>This block sends a byte to the SCI.</p>
+<p>The ErrFlag is set to true <code>rpp_sci_write_nb()</code> returns an error, to false otherwise.</p>
Michal Horn [Mon, 24 Nov 2014 09:40:51 +0000 (10:40 +0100)]
Modify the demo for easier GIO testing
Two more DIN blocks added to test all available configurations,
One more DOUT block added to test the Open-Drain mode, two others
blocks configured for different default output values in Push Pull
mode.
Processing rpp_lib/Configure RX buffer
Processing rpp_lib/Configure TX buffer
Processing rpp_lib/Digital Input
Processing rpp_lib/Digital Input Configure
--- sfunction_dinc.MaskType.old 2014-12-03 16:22:56.932643620 +0100
+++ sfunction_dinc.MaskType.new 2014-12-03 16:22:56.932643620 +0100
@@ -1 +1 @@
-RPP Digital Input Configure
+RPP Digital Input Configure
\ No newline at end of file
Processing rpp_lib/Digital Output
Processing rpp_lib/H-Bridge Control
Processing rpp_lib/IRC Input
Processing rpp_lib/Overrun Detection
Processing rpp_lib/Power Output
Processing rpp_lib/SD-RAM Log Data
--- sfunction_sdrw.MaskType.old 2014-12-03 16:22:59.016603086 +0100
+++ sfunction_sdrw.MaskType.new 2014-12-03 16:22:59.016603086 +0100
@@ -1 +1 @@
-RPP SD-RAM Log Data
+RPP SD-RAM Log Data
\ No newline at end of file
Processing rpp_lib/Serial Configure
--- sfunction_scic.MaskType.old 2014-12-03 16:22:59.348596628 +0100
+++ sfunction_scic.MaskType.new 2014-12-03 16:22:59.348596628 +0100
@@ -1 +1 @@
-RPP Serial Configure
+RPP Serial Configure
\ No newline at end of file
Processing rpp_lib/Serial Printf
--- sfunction_scip.MaskType.old 2014-12-03 16:22:59.664590482 +0100
+++ sfunction_scip.MaskType.new 2014-12-03 16:22:59.664590482 +0100
@@ -1 +1 @@
-RPP Serial Printf
+RPP Serial Printf
\ No newline at end of file
Processing rpp_lib/Serial Receive
--- sfunction_scir.MaskType.old 2014-12-03 16:23:00.072582546 +0100
+++ sfunction_scir.MaskType.new 2014-12-03 16:23:00.072582546 +0100
@@ -1 +1 @@
-RPP Serial Receive
+RPP Serial Receive
\ No newline at end of file
Processing rpp_lib/Serial Send
--- sfunction_scis.MaskType.old 2014-12-03 16:23:00.436575466 +0100
+++ sfunction_scis.MaskType.new 2014-12-03 16:23:00.436575466 +0100
@@ -1 +1 @@
-RPP Serial Send
+RPP Serial Send
\ No newline at end of file
[\bWarning: an error occurred while parsing class fxptui.explorer:
Invalid data type.
]\b
Michal Sojka [Mon, 1 Dec 2014 22:22:24 +0000 (23:22 +0100)]
Update block Mask by running rpp_update_doc
In case the previous content contained some valuable information, which
I forgot to move into YAML blocks, I append the output of
make diff-doc
which prints the diff of the old and new content:
Processing rpp_lib/Analog Input
rpp_lib/Analog Input: MaskDescription not up-to-date
--- sfunction_ain.MaskDescription.old 2014-12-01 23:16:51.938656419 +0100
+++ sfunction_ain.MaskDescription.new 2014-12-01 23:16:51.942656359 +0100
@@ -1,5 +1,3 @@
-Gets the analog value of the specified analog input pin on the RPP board.
-
-The value is an unsigned 16 bit integer between 0-4095 (12 bit ADC).
-
-If an error is detected while getting the value, the ErrFlag is set high.
\ No newline at end of file
+<p>Gets the analog value of the specified analog input pin on the RPP board.</p>
+<p>The value is an unsigned 16 bit integer between 0–4095 (12 bit ADC).</p>
+<p>If an error is detected while reading the value, the ErrFlag is set high.</p>
rpp_lib/Analog Input: MaskPromptString not up-to-date
--- sfunction_ain.MaskPromptString.old 2014-12-01 23:16:52.014655279 +0100
+++ sfunction_ain.MaskPromptString.new 2014-12-01 23:16:52.014655279 +0100
@@ -1 +1 @@
-Pin number [1-12]:
\ No newline at end of file
+Pin number [1–12]:
\ No newline at end of file
Processing rpp_lib/Analog Output
rpp_lib/Analog Output: MaskDescription not up-to-date
--- sfunction_aout.MaskDescription.old 2014-12-01 23:16:52.246651798 +0100
+++ sfunction_aout.MaskDescription.new 2014-12-01 23:16:52.246651798 +0100
@@ -1,6 +1,3 @@
-Sets the analog value of the specified analog output pin on the RPP board.
-
-If 'input is voltage' is set the value must be an unsigned 16 bit integer between 0-12000 (millivolts to set the analog output).
-If 'input is voltage' is NOT set the value must be and unsigned 16 bit integer between 0-4095 (DAC is 12 bit).
-
-If an error is detected while setting the value, the ErrFlag is set high.
\ No newline at end of file
+<p>Sets the analog value of the specified analog output pin on the RPP board.</p>
+<p>If 'input is voltage' is set the value must be an unsigned 16 bit integer between 0-12000 (millivolts to set the analog output). If 'input is voltage' is NOT set the value must be and unsigned 16 bit integer between 0-4095 (DAC is 12 bit).</p>
+<p>If an error is detected while setting the value, the ErrFlag is set high.</p>
rpp_lib/Analog Output: MaskPromptString not up-to-date
--- sfunction_aout.MaskPromptString.old 2014-12-01 23:16:52.318650717 +0100
+++ sfunction_aout.MaskPromptString.new 2014-12-01 23:16:52.318650717 +0100
@@ -1 +1 @@
-Pin number [1-4]:|Input is millivolts.
\ No newline at end of file
+Pin number [1-4]:|Input in millivolts
\ No newline at end of file
Processing rpp_lib/CAN Receive
rpp_lib/CAN Receive: MaskType not up-to-date
--- sfunction_canreceive.MaskType.old 2014-12-01 23:16:52.478648317 +0100
+++ sfunction_canreceive.MaskType.new 2014-12-01 23:16:52.478648317 +0100
@@ -1 +1 @@
-RPP CAN bus receive message
\ No newline at end of file
+RPP CAN Receive
\ No newline at end of file
rpp_lib/CAN Receive: MaskDescription not up-to-date
--- sfunction_canreceive.MaskDescription.old 2014-12-01 23:16:52.566646997 +0100
+++ sfunction_canreceive.MaskDescription.new 2014-12-01 23:16:52.566646997 +0100
@@ -1,7 +1,6 @@
<p>Receive a messages from the CAN bus.</p>
<p>The output can be a uint8, uint16, uint32 number or CAN_MESSAGE object. CAN Unpack block can be used to unpack the data from CAN_MESSAGE object.</p>
<p>A Function-call subsystem is triggered every time when a new message has been received.</p>
-<p>When Mixed is selected in the <i>Message type</i>, the block is able to receive both, the mesages with Standard and Extended identifier.<br>
-<b>NOTE:</b> When Mixed is selected, the <i>Message ID</i> and eventualy the <i>Message ID mask</i> have to be shifted by 18 bits to the left.</p>
-<p>If the <i>Message filter</i> is set to Single ID, only the messages with the one identifier specified in <i>Message ID</i> will be accepted by the block. But when ID & mask is selected, all messages with identifier compliant to logical AND of the <i>Message ID</i> and <i>Message ID mask</i> will be accepted.</p>
-<p>Uncheck <i>Automatic mailbox number</i>, if user defined mailbox number is needed.<br>
\ No newline at end of file
+<p>When Mixed is selected in the <em>Message type</em>, the block is able to receive both, the mesages with Standard and Extended identifier.<br /><strong>NOTE:</strong> When Mixed is selected, the <em>Message ID</em> and eventualy the <em>Message ID mask</em> have to be shifted by 18 bits to the left.</p>
+<p>If the <em>Message filter</em> is set to Single ID, only the messages with the one identifier specified in <em>Message ID</em> will be accepted by the block. But when ID & mask is selected, all messages with identifier compliant to logical AND of the <em>Message ID</em> and <em>Message ID mask</em> will be accepted.</p>
+<p>Uncheck <em>Automatic mailbox number</em>, if user defined mailbox number is needed.</p>
rpp_lib/CAN Receive: MaskPromptString not up-to-date
--- sfunction_canreceive.MaskPromptString.old 2014-12-01 23:16:52.642645856 +0100
+++ sfunction_canreceive.MaskPromptString.new 2014-12-01 23:16:52.642645856 +0100
@@ -1 +1 @@
-Module|Frame type|Message ID filter|Message ID|Message ID mask|Data type|Automatic mailbox number|Mailbox number (1-64)
\ No newline at end of file
+Module:|Frame type:|Message ID filter:|Message ID:|Message ID mask:|Data type:|Automatic mailbox number|Mailbox number [1-64]:
\ No newline at end of file
Processing rpp_lib/CAN Setup
rpp_lib/CAN Setup: MaskType not up-to-date
--- sfunction_cansetup.MaskType.old 2014-12-01 23:16:52.798643516 +0100
+++ sfunction_cansetup.MaskType.new 2014-12-01 23:16:52.798643516 +0100
@@ -1 +1 @@
-RPP CAN setup
\ No newline at end of file
+RPP CAN Setup
\ No newline at end of file
rpp_lib/CAN Setup: MaskDescription not up-to-date
--- sfunction_cansetup.MaskDescription.old 2014-12-01 23:16:52.878642315 +0100
+++ sfunction_cansetup.MaskDescription.new 2014-12-01 23:16:52.878642315 +0100
@@ -1 +1 @@
-Configure CAN bus communication baud rates for every CAN modul. Default value is 500kb/sec.
\ No newline at end of file
+<p>This block configures the CAN bus controllers. Exactly one CAN bus configuration block must be in the model if any of the CAN Receive or CAN Transmit block is used.</p>
rpp_lib/CAN Setup: MaskPromptString not up-to-date
--- sfunction_cansetup.MaskPromptString.old 2014-12-01 23:16:52.946641295 +0100
+++ sfunction_cansetup.MaskPromptString.new 2014-12-01 23:16:52.946641295 +0100
@@ -1 +1 @@
-CAN1 Baudrate (1-1000000 bits/sec)|CAN2 Baudrate (1-1000000 bits/sec)|CAN3 Baudrate (1-1000000 bits/sec)
\ No newline at end of file
+CAN1 baud rate in bps 1 – 10000000:|CAN2 baud rate in bps 1 – 10000000:|CAN3 baud rate in bps 1 – 10000000:
\ No newline at end of file
Processing rpp_lib/CAN Transmit
rpp_lib/CAN Transmit: MaskType not up-to-date
--- sfunction_cantransmit.MaskType.old 2014-12-01 23:16:53.102638954 +0100
+++ sfunction_cantransmit.MaskType.new 2014-12-01 23:16:53.102638954 +0100
@@ -1 +1 @@
-RPP CAN bus transmit a message
\ No newline at end of file
+RPP CAN Transmit
\ No newline at end of file
rpp_lib/CAN Transmit: MaskDescription not up-to-date
--- sfunction_cantransmit.MaskDescription.old 2014-12-01 23:16:53.186637693 +0100
+++ sfunction_cantransmit.MaskDescription.new 2014-12-01 23:16:53.186637693 +0100
@@ -1,4 +1,4 @@
<p>Transmit a CAN message.</p>
<p>Expects a uint8, uint16, uint32 or CAN_MESSAGE object as an input. Use CAN Pack to create the CAN_MESSAGE object.</p>
<p>Matlab expression can be used as Message ID and Mailbox number.</p>
-<p>Uncheck <i>Automatic mailbox number</i>, if user defined mailbox number is needed.<br>
\ No newline at end of file
+<p>Uncheck <em>Automatic mailbox number</em>, if user defined mailbox number is needed.</p>
rpp_lib/CAN Transmit: MaskPromptString not up-to-date
--- sfunction_cantransmit.MaskPromptString.old 2014-12-01 23:16:53.258636612 +0100
+++ sfunction_cantransmit.MaskPromptString.new 2014-12-01 23:16:53.258636612 +0100
@@ -1 +1 @@
-Module|Frame type|Message ID|Automatic mailbox number|Mailbox number (1-64)
\ No newline at end of file
+Module:|Frame type:|Message ID:|Automatic mailbox number|Mailbox number [1–64]:
\ No newline at end of file
Processing rpp_lib/Configure FlexRay node
rpp_lib/Configure FlexRay node: MaskType not up-to-date
--- sfunction_frayconfig.MaskType.old 2014-12-01 23:16:53.434633972 +0100
+++ sfunction_frayconfig.MaskType.new 2014-12-01 23:16:53.434633972 +0100
@@ -0,0 +1 @@
+RPP Configure FlexRay Node
\ No newline at end of file
rpp_lib/Configure FlexRay node: MaskPromptString not up-to-date
--- sfunction_frayconfig.MaskPromptString.old 2014-12-01 23:16:53.614631270 +0100
+++ sfunction_frayconfig.MaskPromptString.new 2014-12-01 23:16:53.614631270 +0100
@@ -1 +1 @@
-gColdStartAttempts|gListenNoise|gMacroPerCycle|gMaxWithoutClockCorrectionFatal|gMaxWithoutClockCorrectionPassive|gNetworkManagementVectorLength|gNumberOfMinislots|gNumberOfStaticSlots|gOffsetCorrectionStart|gPayloadLengthStatic|gSyncNodeMax|gdActionPointOffset|gdCASRxLowMax|gdDynamicSlotIdlePhase|gdMinislot|gdMinislotActionPointOffset|gdNIT|gdSampleClockPeriod|gdStaticSlot|gdTSSTransmitter|gdWakeupSymbolRxIdle|gdWakeupSymbolRxLow|gdWakeupSymbolRxWindow|gdWakeupSymbolTxIdle|gdWakeupSymbolTxLow|pAllowHaltDueToClock|pAllowPassiveToActive|pChannels|pClusterDriftDamping|pDelayCompensationA|pDelayCompensationB|pExternOffsetCorrection|pExternRateCorrection|pKeySlotUsedForStartup|pKeySlotUsedForSync|pLatestTx|pMacroInitialOffsetA|pMacroInitialOffsetB|pMicroInitialOffsetA|pMicroInitialOffsetB|pMicroPerCycle|pRateCorrectionOut|pOffsetCorrectionOut|pSamplesPerMicrotick|pSingleSlotEnabled|pWakeupChannel|pWakeupPattern|pdAcceptedStartupRange|pdListenTimeout|pdMaxDrift|pDecodingCorrection|syncFramePayloadMultiplexEnabled|secureBuffers
\ No newline at end of file
+gColdStartAttempts:|gListenNoise:|gMacroPerCycle:|gMaxWithoutClockCorrectionFatal:|gMaxWithoutClockCorrectionPassive:|gNetworkManagementVectorLength:|gNumberOfMinislots:|gNumberOfStaticSlots:|gOffsetCorrectionStart:|gPayloadLengthStatic:|gSyncNodeMax:|gdActionPointOffset:|gdCASRxLowMax:|gdDynamicSlotIdlePhase:|gdMinislot:|gdMinislotActionPointOffset:|gdNIT:|gdSampleClockPeriod:|gdStaticSlot:|gdTSSTransmitter:|gdWakeupSymbolRxIdle:|gdWakeupSymbolRxLow:|gdWakeupSymbolRxWindow:|gdWakeupSymbolTxIdle:|gdWakeupSymbolTxLow:|pAllowHaltDueToClock|pAllowPassiveToActive:|pChannels:|pClusterDriftDamping:|pDelayCompensationA:|pDelayCompensationB:|pExternOffsetCorrection:|pExternRateCorrection:|pKeySlotUsedForStartup|pKeySlotUsedForSync|pLatestTx:|pMacroInitialOffsetA:|pMacroInitialOffsetB:|pMicroInitialOffsetA:|pMicroInitialOffsetB:|pMicroPerCycle:|pRateCorrectionOut:|pOffsetCorrectionOut:|pSamplesPerMicrotick:|pSingleSlotEnabled:|pWakeupChannel:|pWakeupPattern:|pdAcceptedStartupRange:|pdListenTimeout:|pdMaxDrift:|pDecodingCorrection:|syncFramePayloadMultiplexEnabled|secureBuffers:
\ No newline at end of file
Processing rpp_lib/Configure RX buffer
rpp_lib/Configure RX buffer: MaskType not up-to-date
--- sfunction_frayreceive.MaskType.old 2014-12-01 23:16:53.778628809 +0100
+++ sfunction_frayreceive.MaskType.new 2014-12-01 23:16:53.778628809 +0100
@@ -0,0 +1 @@
+RPP Configure RX buffer
\ No newline at end of file
rpp_lib/Configure RX buffer: MaskPromptString not up-to-date
--- sfunction_frayreceive.MaskPromptString.old 2014-12-01 23:16:53.930626527 +0100
+++ sfunction_frayreceive.MaskPromptString.new 2014-12-01 23:16:53.930626527 +0100
@@ -1 +1 @@
-channel|cycleCounterFiltering|maxPayload (in half-words)|msgBufferInterrupt|payloadPreambleIndicatorTr|singleTransmit|slotId
\ No newline at end of file
+channel:|cycleCounterFiltering:|maxPayload (in half-words):|msgBufferInterrupt|payloadPreambleIndicatorTr|singleTransmit|slotId:
\ No newline at end of file
Processing rpp_lib/Configure TX buffer
rpp_lib/Configure TX buffer: MaskType not up-to-date
--- sfunction_fraytransmit.MaskType.old 2014-12-01 23:16:54.094624066 +0100
+++ sfunction_fraytransmit.MaskType.new 2014-12-01 23:16:54.094624066 +0100
@@ -0,0 +1 @@
+RPP Configure TX buffer
\ No newline at end of file
rpp_lib/Configure TX buffer: MaskPromptString not up-to-date
--- sfunction_fraytransmit.MaskPromptString.old 2014-12-01 23:16:54.246621785 +0100
+++ sfunction_fraytransmit.MaskPromptString.new 2014-12-01 23:16:54.246621785 +0100
@@ -1 +1 @@
-channel|cycleCounterFiltering|maxPayload (in half-words)|msgBufferInterrupt|payloadPreambleIndicatorTr|singleTransmit|slotId
\ No newline at end of file
+channel:|cycleCounterFiltering:|maxPayload (in half-words):|msgBufferInterrupt|payloadPreambleIndicatorTr|singleTransmit|slotId:
\ No newline at end of file
Processing rpp_lib/Digital Input
rpp_lib/Digital Input: MaskDescription not up-to-date
--- sfunction_din.MaskDescription.old 2014-12-01 23:16:54.474618363 +0100
+++ sfunction_din.MaskDescription.new 2014-12-01 23:16:54.474618363 +0100
@@ -1,5 +1,3 @@
-Gets the digital value of the specified digital input pin on the RPP board.
-
-If pin is high the output is 1, 0 if the pin is low.
-
-If an error is detected while getting the pin, the ErrFlag is set high.
\ No newline at end of file
+<p>Gets the digital value of the specified digital input pin on the RPP board.</p>
+<p>If pin is high the output is 1, 0 if the pin is low.</p>
+<p>If an error is detected while getting the pin, the ErrFlag is set high.</p>
rpp_lib/Digital Input: MaskPromptString not up-to-date
--- sfunction_din.MaskPromptString.old 2014-12-01 23:16:54.550617222 +0100
+++ sfunction_din.MaskPromptString.new 2014-12-01 23:16:54.550617222 +0100
@@ -1 +1 @@
-Pin number [0-15]:|User variable threshold|Pull:|Active:
\ No newline at end of file
+Pin number [0-15]:|Use variable threshold|Pull:|Active:
\ No newline at end of file
rpp_lib/Digital Input: MaskHelp not up-to-date
--- sfunction_din.MaskHelp.old 2014-12-01 23:16:54.634615961 +0100
+++ sfunction_din.MaskHelp.new 2014-12-01 23:16:54.634615961 +0100
@@ -1 +1,2 @@
-<p>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.<br />The ErrFlag should raise if <code>rpp_din_update()</code> or <code>rpp_din_get()</code> returns error. <code>rpp_din_update()</code> 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.</p>
+<p>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.</p>
+<p>The ErrFlag should raise if <code>rpp_din_update()</code> or <code>rpp_din_get()</code> returns error. <code>rpp_din_update()</code> 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.</p>
Processing rpp_lib/Digital Input Configure
rpp_lib/Digital Input Configure: MaskDescription not up-to-date
--- sfunction_dinc.MaskDescription.old 2014-12-01 23:16:54.778613800 +0100
+++ sfunction_dinc.MaskDescription.new 2014-12-01 23:16:54.778613800 +0100
@@ -1 +1 @@
-Configure Digital Input Reference Voltage.
\ No newline at end of file
+<p>This block allows one to set reference voltage (threshold) for DIN pins. The block have two parameters, one for pins 8 - 11 and the other for pins 12 - 15.</p>
rpp_lib/Digital Input Configure: MaskPromptString not up-to-date
--- sfunction_dinc.MaskPromptString.old 2014-12-01 23:16:54.850612718 +0100
+++ sfunction_dinc.MaskPromptString.new 2014-12-01 23:16:54.850612718 +0100
@@ -1 +1 @@
-Reference voltage for pins 8-11 [0-4095]|Reference voltage for pins 12-15 [0-4095]
\ No newline at end of file
+Reference voltage for pins 8-11 [0-4095]:|Reference voltage for pins 12-15 [0-4095]:
\ No newline at end of file
Processing rpp_lib/Digital Output
rpp_lib/Digital Output: MaskDescription not up-to-date
--- sfunction_lout.MaskDescription.old 2014-12-01 23:16:55.074609356 +0100
+++ sfunction_lout.MaskDescription.new 2014-12-01 23:16:55.074609356 +0100
@@ -1,5 +1,3 @@
-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.
\ No newline at end of file
+<p>Sends the digital value to the specified logic output pin on the RPP board.</p>
+<p>An input of 1 sets the pin high and 0 sets the pin low.</p>
+<p>If an error is detected while setting the pin, the ErrFlag is set high.</p>
Processing rpp_lib/H-Bridge Control
rpp_lib/H-Bridge Control: MaskDescription not up-to-date
--- sfunction_hbr.MaskDescription.old 2014-12-01 23:16:55.366604973 +0100
+++ sfunction_hbr.MaskDescription.new 2014-12-01 23:16:55.366604973 +0100
@@ -1,3 +1,2 @@
-Control H-Bridge (10A, PWM) at default frequency.
-
-This block expects input in range [-1.0, 1.0].
\ No newline at end of file
+<p>Control H-Bridge (10A, PWM) at default frequency.</p>
+<p>This block expects input in range [-1.0, 1.0].</p>
Processing rpp_lib/IRC Input
rpp_lib/IRC Input: MaskDescription not up-to-date
--- sfunction_irc.MaskDescription.old 2014-12-01 23:16:55.670600408 +0100
+++ sfunction_irc.MaskDescription.new 2014-12-01 23:16:55.670600408 +0100
@@ -1,7 +1 @@
-Gets value of specified IRC.
-
-The value is an 32 bit integer.
-
-Posible IRC numbers explanation
- 1: IRC connected to DIN10 and DIN11.
- 2: IRC connected to DIN14 and DIN15.
\ No newline at end of file
+<p>This block allows to read a value of an IRC sensors. Two configurations are supported: IRC is connected to pins DIN10 and DIN11 and/or pins DIN14 and DIN15. The ErrFlag output raises if an error is detected, which should normally not happen.</p>
Processing rpp_lib/Overrun Detection
rpp_lib/Overrun Detection: MaskType not up-to-date
--- sfunction_tror.MaskType.old 2014-12-01 23:16:55.886597166 +0100
+++ sfunction_tror.MaskType.new 2014-12-01 23:16:55.886597166 +0100
@@ -1 +1 @@
-Overrun detection
\ No newline at end of file
+RPP Overrun Detection
\ No newline at end of file
rpp_lib/Overrun Detection: MaskDescription not up-to-date
--- sfunction_tror.MaskDescription.old 2014-12-01 23:16:55.966595965 +0100
+++ sfunction_tror.MaskDescription.new 2014-12-01 23:16:55.966595965 +0100
@@ -1 +1 @@
-Connected function subsystem is executed when overrun is detected.
\ No newline at end of file
+<p>This block triggers connected simulink function subsystems in case that previous loop took more time than simulation time is set.</p>
Processing rpp_lib/Power Output
rpp_lib/Power Output: MaskDescription not up-to-date
--- sfunction_mout.MaskDescription.old 2014-12-01 23:16:56.254591640 +0100
+++ sfunction_mout.MaskDescription.new 2014-12-01 23:16:56.254591640 +0100
@@ -1 +1 @@
-Toggle RPP Power Outputs (2A, push/pull).
\ No newline at end of file
+<p>This block allows to write the power outputs (2A) on the RPP board. The ErrFlag should raise only if <code>rpp_mout_set()</code> returns error. Note that <code>rpp_mout_set()</code> returns error only if some bad parameter or in case it could detect a faulty condition on the pin in a very very short period of time after setting the value, see the function API for details. If the faulty condition persist on the next step the call will successfully detect the faulty condition and ErrFlag should set. Because the ErrFlag should never set, once set the following steps will never clear it back.</p>
Processing rpp_lib/SD-RAM Log Data
rpp_lib/SD-RAM Log Data: MaskType not up-to-date
--- sfunction_sdrw.MaskType.old 2014-12-01 23:16:56.474588337 +0100
+++ sfunction_sdrw.MaskType.new 2014-12-01 23:16:56.474588337 +0100
@@ -1 +1 @@
-RPP SD-RAM Write (Logging)
\ No newline at end of file
+RPP SD-RAM Write
\ No newline at end of file
rpp_lib/SD-RAM Log Data: MaskDescription not up-to-date
--- sfunction_sdrw.MaskDescription.old 2014-12-01 23:16:56.554587135 +0100
+++ sfunction_sdrw.MaskDescription.new 2014-12-01 23:16:56.554587135 +0100
@@ -1 +1,2 @@
-Log data on SD-RAM.
\ No newline at end of file
+<p>This block allows to log a double value to the SD-RAM. User needs to provide a valid PrintFormat string to format and register the double value on the log. The PrintFormat string should include two specifiers:<br /> 1. For the block ID. Any valid integer specifier.<br /> 2. For the value to log. Any valid double specifier.</p>
+<p>Note that the value of PrintFormat is inserted raw between quotes on code generation and thus there is no validation on it. Error to provide a valid PrintFormat could generate compilation errors or even run-time errors (normally this generates a warning on compile time). Note that the function for logging used is <code>rpp_sdr_printf()</code>, which is a blocking call, and can potentially overrun the step. The ErrFlag will set if <code>rpp_sdr_printf()</code> returns an error (for example out of memory), but will clear back if the next step the call to this function is successful.</p>
rpp_lib/SD-RAM Log Data: MaskPromptString not up-to-date
--- sfunction_sdrw.MaskPromptString.old 2014-12-01 23:16:56.626586054 +0100
+++ sfunction_sdrw.MaskPromptString.new 2014-12-01 23:16:56.626586054 +0100
@@ -1 +1 @@
-Block ID [0-255]:|Printf format for logging (include specifiers):
\ No newline at end of file
+Block ID [0-255]:|Printf format for logging:
\ No newline at end of file
Processing rpp_lib/Serial Configure
rpp_lib/Serial Configure: MaskDescription not up-to-date
--- sfunction_scic.MaskDescription.old 2014-12-01 23:16:56.854582631 +0100
+++ sfunction_scic.MaskDescription.new 2014-12-01 23:16:56.854582631 +0100
@@ -1 +1 @@
-Configure Serial Communication Interface baud rate. Default is 9600.
\ No newline at end of file
+<p>This block allows to configure the baud rate of the SCI. There should be only one block of this type per model, and this requirement is validated.</p>
Processing rpp_lib/Serial Printf
rpp_lib/Serial Printf: MaskDescription not up-to-date
--- sfunction_scip.MaskDescription.old 2014-12-01 23:16:57.158578065 +0100
+++ sfunction_scip.MaskDescription.new 2014-12-01 23:16:57.158578065 +0100
@@ -1 +1,2 @@
-Printf through the Serial Communication Interface.
\ No newline at end of file
+<p>This block allows to print a formatted string to the SCI. The <em>Print format</em> parameter is used as the format specifier for C <code>printf()</code> function. Note that this value is inserted raw between quotes during code generation and thus there is no validation on it. User should always put a valid specifier for the input type of the block.</p>
+<p>Due to Simulink limitations, it is not posible join diferent types into one vector. So one block can be used only for one type of inputs.</p>
rpp_lib/Serial Printf: MaskPromptString not up-to-date
--- sfunction_scip.MaskPromptString.old 2014-12-01 23:16:57.234576924 +0100
+++ sfunction_scip.MaskPromptString.new 2014-12-01 23:16:57.234576924 +0100
@@ -1 +1 @@
-Printf format (must include specifier for arguments):
\ No newline at end of file
+Print format:
\ No newline at end of file
rpp_lib/Serial Printf: MaskHelp not up-to-date
--- sfunction_scip.MaskHelp.old 2014-12-01 23:16:57.314575723 +0100
+++ sfunction_scip.MaskHelp.new 2014-12-01 23:16:57.314575723 +0100
@@ -1,2 +1,2 @@
-<p>This block allows to print a formatted string to the SCI. The PrintFormat string parameters SETTING is used as the format specifier. Note that this value is inserted raw between quotes on code generation and thus there is no validation on it. User should always put any valid specifier for the values on the input of the block.</p>
-<p>Because of Simulink limitations, it is not posible join diferent types in to one vector. So one block can be used only for one type of inputs.</p>
+<p>This block allows to print a formatted string to the SCI. The <em>Print format</em> parameter is used as the format specifier for C <code>printf()</code> function. Note that this value is inserted raw between quotes during code generation and thus there is no validation on it. User should always put a valid specifier for the input type of the block.</p>
+<p>Due to Simulink limitations, it is not posible join diferent types into one vector. So one block can be used only for one type of inputs.</p>
Processing rpp_lib/Serial Receive
rpp_lib/Serial Receive: MaskDescription not up-to-date
--- sfunction_scir.MaskDescription.old 2014-12-01 23:16:57.458573560 +0100
+++ sfunction_scir.MaskDescription.new 2014-12-01 23:16:57.458573560 +0100
@@ -1 +1 @@
-Reads one byte from the Serial Communication Interface.
\ No newline at end of file
+<p>This block allows to receive a byte from the SCI. The ErrFlag should raise if <code>rpp_sci_read_nb()</code> doesn't succeed. The behavior of the ErrFlag is different from others blocks in that this block will set or clear the flag if the call fails of success at each step. Note that this block uses the non-blocking call to read the SCI and thus will never cause an overrun.</p>
Processing rpp_lib/Serial Send
rpp_lib/Serial Send: MaskDescription not up-to-date
--- sfunction_scis.MaskDescription.old 2014-12-01 23:16:57.754569115 +0100
+++ sfunction_scis.MaskDescription.new 2014-12-01 23:16:57.754569115 +0100
@@ -1 +1,2 @@
-Sends one byte through the Serial Communication Interface.
\ No newline at end of file
+<p>This block allows to send a byte to the SCI.</p>
+<p>The ErrFlag will be set only if <code>rpp_sci_write_nb()</code> returns an error.</p>
Michal Sojka [Mon, 1 Dec 2014 22:12:12 +0000 (23:12 +0100)]
doc: Update S-function YAML block to match the current state of the blocks
Mainly description and parameter names were updated. In most cases
descriptions were not checked for correctness (plain copy & paste). In
same cases I updated the text a bit.
Michal Sojka [Mon, 1 Dec 2014 18:00:06 +0000 (19:00 +0100)]
doc: Introduce Help field in YAML doc
The reason is that I want to automatically generate both MaskDescription
and MaskHelp. Currently, these two things are often not consistent. For
now Help is set to be equal to Description, but in a future, Description
is supposed to be shorter (and displayed just in Simulink block),
whereas Help will be longer and will be used also in printed
documentation.
Michal Sojka [Mon, 1 Dec 2014 15:24:28 +0000 (16:24 +0100)]
doc: Update mode parameters of block Mask automatically
This is an attempt to make the blocks more consistent with documentation.
Now the rpp_update_doc script also updates parameter prompt and block
title (tj. MaskType)
In a future, it would also be useful to have MaskDescription updated from
YAML, but we currently have no such a field in the YAML data.
projects / jenkicar / rpp-simulink.git / log