Difference between revisions of "Matlab/Simulink files"
(→sfcn_signal_tower_mcb.m) |
|||
| Line 2: | Line 2: | ||
*'''sfcn_<name>.m''': A function written in MatLAB code describing the S-function block's basic characteristics, such as the number of input ports and the umber of dialog parameters. | *'''sfcn_<name>.m''': A function written in MatLAB code describing the S-function block's basic characteristics, such as the number of input ports and the umber of dialog parameters. | ||
*'''sfcn_<name>_chk.m''': A function written in MatLAB code for checking prerequisites and/or dependencies of using the block, such as that only a single block might be present in the model. | *'''sfcn_<name>_chk.m''': A function written in MatLAB code for checking prerequisites and/or dependencies of using the block, such as that only a single block might be present in the model. | ||
| − | *'''sfcn_<name>_mcb.m''': A function written in MatLAB code that is used for setting up the block's | + | *'''sfcn_<name>_mcb.m''': A function written in MatLAB code that is used for setting up the block's parameters. |
| − | *'''sfcn_<name>.tlc''': A function written in both MatLAB code and C-code, that | + | *'''sfcn_<name>.tlc''': A function written in both MatLAB code and C-code, that transfers the block's settings, input ports and output ports to the C-code and vice versa. |
== sfcn_signal_tower.m == | == sfcn_signal_tower.m == | ||
| Line 28: | Line 28: | ||
*'''hardwareID''': which in this example project is always equal to the Olimexino STM32 | *'''hardwareID''': which in this example project is always equal to the Olimexino STM32 | ||
*'''channel''': selected SPI channel | *'''channel''': selected SPI channel | ||
| − | The function returns a human | + | The function returns a human readable string with information about the each channel.<br> |
| + | Information about the hardware_ID is omitted, because this is always the same for this example project.<br> | ||
| + | The value of the variable '''channelStr''' is what will be used in the C-code. The value of channelStr depends on '''channel''', which is selected by the user in the block's dialog. | ||
== sfcn_signal_tower.tlc == | == sfcn_signal_tower.tlc == | ||
'''File location: .\blockset\toolbox\STM32\blocks\tlc_csfcn_signal_tower.tlc'''<br> | '''File location: .\blockset\toolbox\STM32\blocks\tlc_csfcn_signal_tower.tlc'''<br> | ||
| − | <br> | + | This file is the target language compiler (TLC) file that contains the code generation specifics.<br> |
| + | The file starts by including the header file ws2812b.h<br> | ||
| + | This file contains two functions: | ||
| + | *Start<br> | ||
| + | This function is called once when the model starts. In this function the ws2812b_init() function is called for initializing the target hardware.<br> | ||
| + | The channel parameter is read from the block by using the MatLAB macro '''%<block.RTWdata.channel>'''. | ||
| + | *Update | ||
Revision as of 14:31, 28 February 2019
Creating a custom S-function block requires the addition of four files to the MatLAB/Simulink project.
- sfcn_<name>.m: A function written in MatLAB code describing the S-function block's basic characteristics, such as the number of input ports and the umber of dialog parameters.
- sfcn_<name>_chk.m: A function written in MatLAB code for checking prerequisites and/or dependencies of using the block, such as that only a single block might be present in the model.
- sfcn_<name>_mcb.m: A function written in MatLAB code that is used for setting up the block's parameters.
- sfcn_<name>.tlc: A function written in both MatLAB code and C-code, that transfers the block's settings, input ports and output ports to the C-code and vice versa.
Contents
sfcn_signal_tower.m
File location: ./blockset/toolbox/STM32/blocks/sfcn_signal_tower.m
Each layer of the signal tower requires three input ports: one for each RGB color.
As there are four layers, a total of twelve input ports are created in the setup function.
Notice that the DataTtypeID of each port is set to 3, which means that the ports requires data of type uint8_T.
The range of a uint8_T variable is 0-255.
The S-function requires two dialog parameters:
- The selected hardware target, which in this example project will always be the Olimexino STM32
- The selected SPI channel.
This number of parameters is set by the following line of code:
block.NumDialogPrms = 2;
sfcn_signal_tower_chk.m
File location: .\blockset\toolbox\STM32\blocks\sfcn_signal_tower_chk.m
The Olimexino STM32 features two SPI channels. This function checks if there more than two signal tower blocks in the model and will generate an error message.
sfcn_signal_tower_mcb.m
File location: .\blockset\toolbox\STM32\blocks\sfcn_signal_tower_mcb.m
The function sfcn_signal_tower_mcb takes two parameters:
- hardwareID: which in this example project is always equal to the Olimexino STM32
- channel: selected SPI channel
The function returns a human readable string with information about the each channel.
Information about the hardware_ID is omitted, because this is always the same for this example project.
The value of the variable channelStr is what will be used in the C-code. The value of channelStr depends on channel, which is selected by the user in the block's dialog.
sfcn_signal_tower.tlc
File location: .\blockset\toolbox\STM32\blocks\tlc_csfcn_signal_tower.tlc
This file is the target language compiler (TLC) file that contains the code generation specifics.
The file starts by including the header file ws2812b.h
This file contains two functions:
- Start
This function is called once when the model starts. In this function the ws2812b_init() function is called for initializing the target hardware.
The channel parameter is read from the block by using the MatLAB macro %<block.RTWdata.channel>.
- Update
