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.
22 files changed:
range: //str
Outputs: *iodef
Parameters: *iodef
range: //str
Outputs: *iodef
Parameters: *iodef
+ Description: //str # Only for desciprion in block properties
+ Help: //str # For help window and printed documentation
Status:
type: //rec
required:
Status:
type: //rec
required:
Parameters:
- { name: "Pin number", type: "uint8", range: "[1–12]" }
Parameters:
- { name: "Pin number", type: "uint8", range: "[1–12]" }
-# Description is in Markdown mark-up
-Description: |
+# Description and Help is in Markdown mark-up
+Description: &desc |
This block allows to read the analog inputs on the RPP board. The
ErrFlag should if raise `rpp_adc_update()` or `rpp_adc_get()`
This block allows to read the analog inputs on the RPP board. The
ErrFlag should if raise `rpp_adc_update()` or `rpp_adc_get()`
always be 0. Because the ErrFlag should never set, once set the
following steps will never clear it back.
always be 0. Because the ErrFlag should never set, once set the
following steps will never clear it back.
Status:
Tested:
- Changing the pin.
Status:
Tested:
- Changing the pin.
- { name: "Pin number [1-4]", type: "uint8" }
- { name: "UseVoltage", type: "bool" }
- { name: "Pin number [1-4]", type: "uint8" }
- { name: "UseVoltage", type: "bool" }
-# Description is in Markdown mark-up
-Description: |
+# Description and Help is in Markdown mark-up
+Description: &desc |
Sets the analog value of the specified analog output pin on the RPP board. If an error is detected
while setting the value, the ErrFlag is set high.
Sets the analog value of the specified analog output pin on the RPP board. If an error is detected
while setting the value, the ErrFlag is set high.
Because of this, the outputs of the DACs are initialized on the first step of the model and not on
the model initialization.
Because of this, the outputs of the DACs are initialized on the first step of the model and not on
the model initialization.
Status:
Tested:
- Changing the pin, voltage/value flag.
Status:
Tested:
- Changing the pin, voltage/value flag.
- { name: "Automatic mailbox number", type: "bool" }
- { name: "Mailbox number (0-31)", type: "int8" }
- { name: "Automatic mailbox number", type: "bool" }
- { name: "Mailbox number (0-31)", type: "int8" }
-# Description is in Markdown mark-up
-Description: |
+# Description and Help is in Markdown mark-up
+Description: &desc |
This block allows receiving messages from the CAN bus. It can be
configured for any of the CAN ports (modules) CAN1, CAN2 or CAN3.
This block allows receiving messages from the CAN bus. It can be
configured for any of the CAN ports (modules) CAN1, CAN2 or CAN3.
In order to use this block, there must be a `CAN Configure` block in the model.
In order to use this block, there must be a `CAN Configure` block in the model.
Status:
Tested:
- Reception of messages with a configured ID.
Status:
Tested:
- Reception of messages with a configured ID.
- { name: "Baud rate for CAN bus port 2 [bps]", type: "uint32", range: "1 – 10000000" }
- { name: "Baud rate for CAN bus port 3 [bps]", type: "uint32", range: "1 – 10000000" }
- { name: "Baud rate for CAN bus port 2 [bps]", type: "uint32", range: "1 – 10000000" }
- { name: "Baud rate for CAN bus port 3 [bps]", type: "uint32", range: "1 – 10000000" }
-# Description is in Markdown mark-up
-Description: |
+# Description and Help is in Markdown mark-up
+Description: &desc |
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.
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.
Status:
Tested:
- Configuring CAN1, CAN2 and CAN3
Status:
Tested:
- Configuring CAN1, CAN2 and CAN3
- { name: "Automatic mailbox number", type: "bool" }
- { name: "Mailbox number", type: "int8" }
- { name: "Automatic mailbox number", type: "bool" }
- { name: "Mailbox number", type: "int8" }
-# Description is in Markdown mark-up
-Description: |
+# Description and Help is in Markdown mark-up
+Description: &desc |
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.
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.
In order to use this block, there must be a `CAN Configure` block in the model.
In order to use this block, there must be a `CAN Configure` block in the model.
Status:
Tested:
- Transmission of the message with configured ID
Status:
Tested:
- Transmission of the message with configured ID
- { name: "Pull", type: "Choice from Pull-down or Pull-up" }
- { name: "Active", type: "Choice from Active or Tri-stated" }
- { 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: |
+# Description and Help is in Markdown mark-up
+Description: &desc |
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
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
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.
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:
- Changing the pin.
Status:
Tested:
- Changing the pin.
- { name: "Reference voltage for pins 8-11 [0-4095]", type: "uint16" }
- { name: "Reference voltage for pins 12-15 [0-4095]", type: "uint16" }
- { name: "Reference voltage for pins 8-11 [0-4095]", type: "uint16" }
- { name: "Reference voltage for pins 12-15 [0-4095]", type: "uint16" }
-# Description is in Markdown mark-up
-Description: |
+# Description and Help is in Markdown mark-up
+Description: &desc |
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.
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.
Status:
Tested:
- Changing reference voltage.
Status:
Tested:
- Changing reference voltage.
- { name: "syncFramePayloadMultiplexEnabled", type: "bool" }
- { name: "secureBuffers", type: "uint8" }
- { name: "syncFramePayloadMultiplexEnabled", type: "bool" }
- { name: "secureBuffers", type: "uint8" }
-# Description is in Markdown mark-up
-Description: |
+# Description and Help is in Markdown mark-up
+Description: &desc |
Status:
Tested:
Untested:
Status:
Tested:
Untested:
- { name: "singleTransmit", type: "bool" }
- { name: "slotId", type: "uint32" }
- { name: "singleTransmit", type: "bool" }
- { name: "slotId", type: "uint32" }
-# Description is in Markdown mark-up
-Description: |
+# Description and Help is in Markdown mark-up
+Description: &desc |
Status:
Tested:
Untested:
Status:
Tested:
Untested:
-# Description is in Markdown mark-up
-Description: |
+# Description and Help is in Markdown mark-up
+Description: &desc |
Status:
Tested:
Untested:
Status:
Tested:
Untested:
- { name: "singleTransmit", type: "bool" }
- { name: "slotId", type: "uint32" }
- { name: "singleTransmit", type: "bool" }
- { name: "slotId", type: "uint32" }
-# Description is in Markdown mark-up
-Description: |
+# Description and Help is in Markdown mark-up
+Description: &desc |
Status:
Tested:
Untested:
Status:
Tested:
Untested:
-# Description is in Markdown mark-up
-Description: |
+# Description and Help is in Markdown mark-up
+Description: &desc |
This block allows to control the H-Bridge on the RPP board. The ErrFlag should raise only if
`rpp_hbr_control()` returns error. The H-Bridge is initialized with the default frequency
(~18kHz). A future improvement could include a parameter to set the frequency. Because the ErrFlag
should never set, once set the following steps will never clear it back.
This block allows to control the H-Bridge on the RPP board. The ErrFlag should raise only if
`rpp_hbr_control()` returns error. The H-Bridge is initialized with the default frequency
(~18kHz). A future improvement could include a parameter to set the frequency. Because the ErrFlag
should never set, once set the following steps will never clear it back.
Status:
Tested:
- Compilation and general use.
Status:
Tested:
- Compilation and general use.
Parameters:
- { name: "IRC number [1-2]", type: "uint8" }
Parameters:
- { name: "IRC number [1-2]", type: "uint8" }
-# Description is in Markdown mark-up
-Description: |
+# Description and Help is in Markdown mark-up
+Description: &desc |
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.
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.
Status:
Tested:
- Compilation and general use.
Status:
Tested:
- Compilation and general use.
Parameters:
- { name: "Pin number [1-8]", type: "uint8" }
Parameters:
- { name: "Pin number [1-8]", type: "uint8" }
-# Description is in Markdown mark-up
-Description: |
+# Description and Help is in Markdown mark-up
+Description: &desc |
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.
Status:
Tested:
- Changing the pin.
Status:
Tested:
- Changing the pin.
Parameters:
- { name: "Pin number [1-6]", type: "uint8" }
Parameters:
- { name: "Pin number [1-6]", type: "uint8" }
-# Description is in Markdown mark-up
-Description: |
+# Description and Help is in Markdown mark-up
+Description: &desc |
This block allows to write the power outputs (2A) on the RPP board. The ErrFlag should raise only
if `rpp_mout_set()` returns error. Note that `rpp_mout_set()` returns error only if some bad
This block allows to write the power outputs (2A) on the RPP board. The ErrFlag should raise only
if `rpp_mout_set()` returns error. Note that `rpp_mout_set()` returns error only if some bad
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.
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.
Status:
Tested:
- Changing the pin.
Status:
Tested:
- Changing the pin.
Parameters:
- { name: "Baud rate", type: "uint32" }
Parameters:
- { name: "Baud rate", type: "uint32" }
-# Description is in Markdown mark-up
-Description: |
+# Description and Help is in Markdown mark-up
+Description: &desc |
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.
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.
Status:
Tested:
- Changing baud rate.
Status:
Tested:
- Changing baud rate.
Parameters:
- { name: "PrintFormat [SETTING]", type: "string" }
Parameters:
- { name: "PrintFormat [SETTING]", type: "string" }
-# Description is in Markdown mark-up
-Description: |
+# Description and Help is in Markdown mark-up
+Description: &desc |
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
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
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.
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.
Status:
Tested:
- Sending data.
Status:
Tested:
- Sending data.
-# Description is in Markdown mark-up
-Description: |
+# Description and Help is in Markdown mark-up
+Description: &desc |
This block allows to receive a byte from the SCI. The ErrFlag should raise if `rpp_sci_read_nb()`
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.
This block allows to receive a byte from the SCI. The ErrFlag should raise if `rpp_sci_read_nb()`
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.
Status:
Tested:
- Receiving data.
Status:
Tested:
- Receiving data.
-# Description is in Markdown mark-up
-Description: |
+# Description and Help is in Markdown mark-up
+Description: &desc |
This block allows to send a byte to the SCI.
The ErrFlag will be set only if `rpp_sci_write_nb()` returns an error.
This block allows to send a byte to the SCI.
The ErrFlag will be set only if `rpp_sci_write_nb()` returns an error.
Status:
Tested:
- Sending data.
Status:
Tested:
- Sending data.
- { name: "Block ID", type: "uint8" }
- { name: "PrintFormat [SETTING]", type: "string" }
- { name: "Block ID", type: "uint8" }
- { name: "PrintFormat [SETTING]", type: "string" }
-# Description is in Markdown mark-up
-Description: |
+# Description and Help is in Markdown mark-up
+Description: &desc |
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
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
step. The ErrFlag will set if `rpp_sdr_printf()` returns an error (for example out of memory),
but will clear back if the next step the call to this function is successful.
step. The ErrFlag will set if `rpp_sdr_printf()` returns an error (for example out of memory),
but will clear back if the next step the call to this function is successful.
Status:
Tested:
- Logging data.
Status:
Tested:
- Logging data.
-# Description is in Markdown mark-up
-Description: |
+# Description and Help is in Markdown mark-up
+Description: &desc |
This block triggers connected simulink function subsystems in case that
previous loop took more time than simulation time is set.
This block triggers connected simulink function subsystems in case that
previous loop took more time than simulation time is set.
Status:
Tested:
- Overun detection.
Status:
Tested:
- Overun detection.