{"id":14927,"date":"2023-08-08T10:18:48","date_gmt":"2023-08-08T14:18:48","guid":{"rendered":"https:\/\/blogs.mathworks.com\/simulink\/?p=14927"},"modified":"2023-08-08T10:37:41","modified_gmt":"2023-08-08T14:37:41","slug":"tips-for-working-with-simulink-libraries-and-data-dictionaries","status":"publish","type":"post","link":"https:\/\/blogs.mathworks.com\/simulink\/2023\/08\/08\/tips-for-working-with-simulink-libraries-and-data-dictionaries\/","title":{"rendered":"Tips for Working with Simulink Libraries and Data Dictionaries"},"content":{"rendered":"
\r\n
I came across an interesting feature recently for Simulink\u00ae libraries that could be helpful when working with buses and other types associated with them.<\/div>\r\n

The Problem<\/h2>\r\n
Let's say we have a library with multiple blocks that use a specific bus on their interfaces, for example, myBus<\/span>. When generating code for our models I recommend using non-virtual bus definitions so we can have strict control over how these buses appear in the code. This bus has 3 elements, a boolean<\/span>, sel<\/span>, and two uint32<\/span> values, a1 and a2<\/span>. As a specific example, one of the blocks from our library uses this bus for a selection operation.<\/div>\r\n
\"myLibBlock.png\"<\/div>\r\n
When we want to use these library blocks in one of our models, we'll need to have myBus<\/span> defined somewhere in the scope of this model. This means that each model that uses blocks from this library must have a setup script or be associated with a Simulink data dictionary. Conceptually, our setup would look like this diagram:<\/div>\r\n
\"\"<\/div>\r\n
In the above figure, the yellow arrows indicate library block usage and the blue arrows show data dictionary links.<\/div>\r\n

The Desired Situation<\/h2>\r\n
This setup works, but it would be better if we could have the definition of myBus<\/span> come along with the library instead. This would save our library users time and streamline their workflows. Conceptually, we want to follow the guiding principle that the interface for a reusable component is stored with that component<\/span>. With this in mind, our diagram should look like this:<\/div>\r\n
\"\"<\/div>\r\n
Here the dictionary containing <\/span>myBus<\/span> will automatically be included in any model that uses blocks from the library.<\/span> We'll show how to do this in the following section.<\/div>\r\n

Associating a Dictionary with a Library<\/h2>\r\n
Let's start by creating the required bus definition in a data dictionary. From the Model Explorer, we choose File->New Data Dictionary<\/span> and provide a file name. We'll call it myLibDict.sldd<\/span>. Next, we'll select the Design Data section of the dictionary and choose Add->Simulink Bus<\/span>, and rename the bus to myBus.<\/div>\r\n
We'll add the elements to this bus using the new Type Editor<\/a> interface:<\/div>\r\n
\"typeEditor.png\"<\/div>\r\n
In this interface, we can set up the element names, data type, etc. for our bus elements. Once we're done, we can see the bus definition in the dictionary in the Model Explorer:<\/div>\r\n
\"myBusDef.png\"<\/div>\r\n
Now that we have this definition, we associate myLibDict.sldd <\/span>with myLib.slx<\/span>. Start by selecting myLib in the left panel of Model Explorer and choosing the External Data tab in the right panel. In the Data Dictionary Field, enter myLibDict.sldd<\/span> and press apply. Here I've cropped and zoomed in on the relevant panels.<\/div>\r\n
\"AssocLibLeft.png\" \"AssocLibRight.png\"<\/div>\r\n
Once we've done this, we can see this association in the External Data field in the Model Explorer:<\/div>\r\n
\"myLibConf.png\"<\/div>\r\n
Any model that uses the library will now automatically have access the bus definition. Specifically, myModel.slx<\/span>, which uses the library block, can use the bus definition. In this case, the input is defined to be of type myBus<\/span>. This is clear when we update the diagram for myModel<\/span>.<\/div>\r\n
\"myModel.png\"<\/div>\r\n

Housekeeping for Library Dictionaries<\/h2>\r\n
Occasionally, we may need to restructure the files in a project or share it via archive<\/a>. When we do this, the library dictionary dependencies will need to be recomputed because they are cached on disk in the user preferences file<\/a> to increase performance during diagram updates. We'll show examples of how to handle these situations in this section.<\/div>\r\n

Example 1: Reorganizing our Files<\/h4>\r\n
Now let's say we want to reorganize our project and move our library to a directory called \"Libraries\". Initially the files are all in the root folder of the project:<\/div>\r\n
\"preMoveFolder.png\"<\/div>\r\n
We create the directory \"Libraries\" and move myLib.slx<\/span> and myLibDict.sldd<\/span> to this directory and add it to our path:<\/div>\r\n
\"postMoveFolder.png\"<\/div>\r\n
After this move, we get an error when we try to simulate our model:<\/div>\r\n
\"simError.png\"<\/div>\r\n
To fix this error, we need to close the dictionary with Simulink.data.dictionary.closeAll()<\/span><\/a> and refresh the links with Simulink.LibraryDictionary.refresh()<\/span><\/a>.<\/div>\r\n
\r\n
Simulink.data.dictionary.closeAll()<\/span><\/div>\r\n
Simulink.LibraryDictionary.refresh('.\/Libraries'<\/span>)<\/span><\/div>\r\n<\/div>\r\n
This will update the cached dictionary dependency analysis and allow us to simulate myModel<\/span>.<\/div>\r\n

Example 2: Sharing an Archive<\/h4>\r\n
As a final example, let's say we want to share our project with a colleague via an archive, let's call it myProject.mlproj<\/span>. We can prevent the above error when our colleague opens this project and attempts to simulate myModel<\/span> by adding the following line to a project startup script. Here we can see the script myStartupScript.m<\/span> in our project and the code in the editor. Note that the Run At Startup icon is set in the Status column (circled in red). We get this by right-clicking on myStartupScript.m<\/span> in the project window and selecting Run At Startup<\/span> from the menu.<\/div>\r\n
\"StartupScript.png\"<\/div>\r\n
This will allow our colleague to simulate and generate code from the model.<\/div>\r\n

Now It's Your Turn<\/h2>\r\n
How do you store your buses and interfaces? Do you find this feature useful? Please let us know in the comments below.<\/div>\r\n
\"\"<\/a><\/div>\r\n
<\/div>\r\n
<\/div>\r\n
<\/div>\r\n<\/div>\r\n