print_markdown_as('latex', doc['Description'])
- print("\n\\textbf{Status:}")
- print("\\begin{multicols}{3}")
- if doc['Status']['Tested']:
- print("\\begin{compactitem}")
- print("\\item \\textbf{Tested}:")
- print(" \\begin{compactitem}")
- print("\n".join(["\\item %s" % i.replace('_', '\\_') for i in doc['Status']['Tested']]))
- print(" \\end{compactitem}")
- print("\\end{compactitem}")
- else:
- print("\\ ")
-
- print("\\vfill\\columnbreak")
-
- if doc['Status']['Untested']:
- print("\\begin{compactitem}")
- print("\\item \\textbf{Untested}:")
- print(" \\begin{compactitem}")
- print("\n".join(["\\item %s" % i.replace('_', '\\_') for i in doc['Status']['Untested']]))
- print(" \\end{compactitem}")
- print("\\end{compactitem}")
- else:
- print("\\ ")
-
- print("\\vfill\\columnbreak")
-
- if doc['Status']['Not working']:
- print("\\begin{compactitem}")
- print("\\item \\textbf{Not working}:")
- print(" \\begin{compactitem}")
- print("\n".join(["\\item %s" % i.replace('_', '\\_') for i in doc['Status']['Not working']]))
- print(" \\end{compactitem}")
- print("\\end{compactitem}")
- else:
- print("\\ ")
-
- print("\\end{multicols}\n")
-
if doc.get('RPP API functions used', None) is not None:
print("\\textbf{RPP API functions used:}")
print("\\begin{compactitem}")
global last_category
if last_category == doc['Category']: doc['Category']=''
doc['Header'] = doc['Header'].replace('_', '\\_')
- if doc['Status']['Not working']: doc['ShortStatus'] = '$\\alpha$'
- elif doc['Status']['Untested']: doc['ShortStatus'] = '$\\beta$'
- elif not doc['Status']['Tested']: doc['ShortStatus'] = '$\\beta$'
- else: doc['ShortStatus'] = 'Stable'
- print(Template("$Category & $Name & $ShortStatus & $Mnemonic & \\texttt{$Header} \\\\").substitute(doc))
+ print(Template("$Category & $Name & $Status & $Mnemonic & \\texttt{$Header} \\\\").substitute(doc))
if doc['Category']:
last_category = doc['Category']
if args.masktype:
Parameters: *iodef
Description: //str # Only for desciprion in block properties
Help: //str # For help window and printed documentation
- Status:
- type: //rec
- required:
- Tested: &strarray
- type: //any
- of:
- - //nil
- - type: //arr
- contents: //str
- Untested: *strarray
- Not working: *strarray
+ Status: //str # Alpha / Beta / Stable / ...
optional:
- RPP API functions used: *strarray
+ RPP API functions used: &strarray
+ type: //any
+ of:
+ - //nil
+ - type: //arr
+ contents: //str
Relevant demos: *strarray
always be 0. Because the ErrFlag should never set, once set the
following steps will never clear it back.
-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_adc_update()
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.
- - Compilation and general use.
- Untested:
- - Faulty situation for the ErrFlag to set.
- Not working:
- - Initializing DACs on model's initialization.
+Status: Stable
RPP API functions used:
- rpp_dac_setup()
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.
- - Rejection of messages with other ID then the configured one. FIXME
- - Reception of messages with a set of IDs specified by a ID and mask.
- - Reception of messages with Standard ID type, rejection of the messages with Extended ID type and vice versa.
- - Reception of messages with both messages ID types.
- - Automatic generation of mailboxes numbers with combination with manual specification, duplicate mailbox numbers detection.
- - Function call triggering when new message is accepted
- Untested:
- - Handling of error states on CAN bus
- Not working:
- - Receiving at baudrate higher than 700kb
- - External mode - throwing syntax error during compilation
+Status: Stable
RPP API functions used:
- rpp_can_read()
Help: *desc
-Status:
- Tested:
- - Configuring CAN1, CAN2 and CAN3
- Untested:
- Not working:
- - Receiving at baudrate higher than 700kb
- - External mode - throwing syntax error during compilation
+Status: Stable
RPP API functions used:
- rpp_can_init()
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
- - Automatic generation of mailboxes numbers in combination with
- manual specification in other blocks. Colliding mailbox numbers
- are correctly handled.
- - Input message data type recognition
- - When unsupported data type is connected to the Msg input port, Simulink generates a reasonable error message
- Untested:
- - Handling of error states on CAN bus
- Not working:
- - External mode - throwing syntax error during compilation
+Status: Stable
RPP API functions used:
- rpp_can_write()
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.
- - Compilation and general use.
- - Using variable threshold.
- Untested:
- - Faulty situation for the ErrFlag to set.
- Not working:
+Status: Stable
RPP API functions used:
- rpp_din_setup()
Help: *desc
-Status:
- Tested:
- - Changing reference voltage.
- - Compilation and general use.
- Untested:
- - Using more than one block in a model.
- Not working:
+Status: Stable
RPP API functions used:
- rpp_din_ref()
Help: *desc
-Status:
- Tested:
- Untested:
- Not working:
- - Unknown status
+Status: Beta
RPP API functions used:
Help: *desc
-Status:
- Tested:
- Untested:
- Not working:
- - Unknown status
+Status: Beta
RPP API functions used:
Help: *desc
-Status:
- Tested:
- Untested:
- Not working:
- - Unknown status
- - Not in library
+Status: Beta
RPP API functions used:
Help: *desc
-Status:
- Tested:
- Untested:
- Not working:
- - Unknown status
+Status: Beta
RPP API functions used:
(~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.
- Untested:
- - Faulty situation for the ErrFlag to set.
- Not working:
+Status: Stable
RPP API functions used:
- rpp_hbr_enable()
Help: *desc
-Status:
- Tested:
- - Compilation and general use.
- Untested:
- - Faulty situation for the ErrFlag to set.
- Not working:
+Status: Stable
RPP API functions used:
- rpp_irc_enable()
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.
- - Compilation and general use.
- Untested:
- - Faulty situation for the ErrFlag to set.
- Not working:
+Status: Stable
RPP API functions used:
- rpp_lout_set()
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_mout_set()
Help: *desc
-Status:
- Tested:
- - Changing baud rate.
- - Compilation and general use.
- Untested:
- Not working:
+Status: Stable
RPP API functions used:
- rpp_sci_setup()
Help: *desc
-Status:
- Tested:
- - Sending data.
- - Compilation and general use.
- Untested:
- - Faulty situation for the ErrFlag to set.
- Not working:
+Status: Stable
RPP API functions used:
- rpp_sci_printf()
Help: *desc
-Status:
- Tested:
- - Receiving data.
- - Compilation and general use.
- - Faulty situation for the ErrFlag to set.
- Untested:
- Not working:
+Status: Stable
RPP API functions used:
- rpp_sci_read_nb()
Help: *desc
-Status:
- Tested:
- - Sending data.
- - Compilation and general use.
- Untested:
- - Faulty situation for the ErrFlag to set.
- Not working:
+Status: Stable
RPP API functions used:
- rpp_sci_write_nb()
Help: *desc
-Status:
- Tested:
- - Logging data.
- - Compilation and general use.
- Untested:
- - Faulty situation for the ErrFlag to set.
- Not working:
+Status: Beta
RPP API functions used:
- rpp_sdr_printf()
Help: *desc
-Status:
- Tested:
- - Overun detection.
- - Compilation.
- Untested:
- Not working:
+Status: Stable
RPP API functions used:
projects / jenkicar / rpp-simulink.git / commitdiff