On early stages of electronic designs, it is important to define the design on the conceptual/functional level. This initial step serves as a crucial foundation for the entire development process, providing a high-level overview of the system's architecture and its primary elements. A well-crafted block diagram clarifies the major functional units of the electronic system and illustrates their interconnections. It helps in visualizing how different parts of the design will interact, without getting bogged down in the intricate details of individual part implementations. This abstraction allows you to focus on the system's overall behavior and relationships between modules, ensuring that all essential functionalities are accounted for and that the system's architecture aligns with the design requirements.
An Electronic System Design (ESD) document allows you to design system-level block diagrams and collaborate with your customers.
Creating a New ESD Document
A new ESD document can be created as part of a solution that resides in your Renesas 365 Workspace. On the detailed page of a solution, click the
button at the top right and select System Design from the menu that appears to open the Create ESD window.
The window will initially present in a simplified view, with the following fields:
To access more controls, click the
button. The Parent Folder field will present. Use this field to specify where the ESD document is to be created within the Workspace's folder structure. By default, this is the Projects folder. Click the Change link at the right of the field to access the folder structure for the Workspace, from which to select an alternate folder to store the document (
).
After defining the new ESD document as required, click
. You will come back to the solution's detailed page, where you will now see a tile for the newly created ESD document.
To open an ESD document, click its name within its tile or click the
button and select Open from the menu that appears. Alternatively, double-click directly on the required ESD document tile or click the name of the document.
Defining an ESD Document
In an ESD document, specific functions, operations, or devices (such as signal processing or MPU) are represented by functional blocks. From perspective of its structure and visual representation, a functional block is a container that can include a graphical shape/image (with label), key component(s) of the function represented by hardware/software object(s), ports, and other blocks. Ports can be used to represent interfaces of a functional block (for example, the I2C interface of an MPU) and connection lines between functional blocks (placed directly between blocks or their ports) represent interconnections (for example, signals flowing between interfaces of different devices).
Placing and Editing Commonality
Use the following collapsible sections to learn more about working in the ESD document editor.
Controlling the View of the Document
Browsing controls for the main viewing area are as follows:
-
Right-Click, Hold&Drag to pan document.
-
Mouse Wheel to scroll vertically.
-
Shift+Mouse Wheel to scroll vertically.
-
Ctrl+Mouse Wheel to zoom in/out.
You can also use the Zoom drop-down at the bottom right of the design space to select a zoom value. Select the Zoom to Fit option from the drop-down to display all design objects on the document.
Selecting Objects
An object placed in an ESD document must be selected before performing an operation on it, such as editing its object location or size, performing a clipboard operation (cut/copy) or removal, etc.
In the most basic case, you can select an individual design object by hovering the cursor over it and clicking. Once selected, certain design objects can be changed graphically with respect to their size and/or shape. The object will become selected and editing handles will be shown at various editing points around the object. To change the shape and/or size of the object, click and drag an editing handle. The exact nature of the change will depend on the object you are editing.
Click away from a selected object or press Esc to deselect it.
Pressing Esc deselects objects hierarchically. For example, if a hardware component is selected, pressing Esc will deselect the component and select the functional block in which this component is placed. If a selected functional block is placed within a blanket, pressing Esc will deselect the functional block and select the blanket.
Note that selection with clicking is not cumulative. The selected object deselects when you click on another object. To select multiple objects, hold the Shift key then sequentially click the objects you want selected or deselected. In other words, the Shift+Click shortcut changes the selection status of the object currently under the cursor without affecting the status of other objects.
Where a group of objects overlap, click repeatedly to cycle through the objects, selection-wise, with the object at the front selected first then the object drawn next behind it selected, and so on.
To select a number of objects located in a specific area of the design document, you can use a selection rectangle. Click and Hold away from objects in the corner of the imaginary rectangle enclosing the objects to be selected then drag to the opposite corner of this rectangle. All visible objects that are within the selection rectangle and those that touch the selection rectangle will be selected.
To select all objects in the ESD document, you can also use the Ctrl+A shortcut.
Alignment Guides
To place objects precisely in the design space and align them vertically and/or horizontally with other objects, indicator lines appear when you place or drag an object (or group of objects) and it is aligned with other objects in the document. Also, arrows appear when the object(s) being placed/dragged to match the distribution of placed objects nearby.
Arranging Objects
Objects placed in an ESD document are automatically stacked in layers. Each object is on a different layer depending on the creation order and, therefore, it is possible to place objects so that they overlap. The objects created or added recently are always on the top layer.
Using the following commands of the Arrange sub-menu of the right-click menu, you move an object in an overlapping object stack of which this object is a part:
-
Bring to Front (Ctrl+Alt+]) / Send to Back (Ctrl+Alt+[) – move an object that is part of a stack of overlapping objects to the front/back of all other objects in that stack. After launching the command, click the object that you want to move. The object will be moved to the top/bottom of the stack in front of / behind all overlapping objects without changing its x or y coordinates.
-
Bring Forward (Ctrl+]) / Send Backward (Ctrl+[) – move one object in front of / behind another object in a stack of overlapping objects. After launching the command, click the object that you want to move, then click a 'target' object that you wish to move the first object in front of / behind. The first object will be moved in front of / behind this target object without changing its x or y coordinates.
You can also select an object or multiple objects before choosing a command. In this case, the command applies to the selected object(s).
Using Cut/Copy and Paste
You can cut/copy and paste objects within or between ESD documents. Select the object(s) you want to cut/copy, right-click in the design space and select the Cut (shortcut: Ctrl+X) / Copy (shortcut: Ctrl+C) command from the context menu. To place the last cut/copied content into the document, right-click within the design space and choose the Paste command from the context menu (shortcut: Ctrl+V).
Changing Object Style
When one or multiple objects are selected in the ESD document, you can change their style (visual representation in the design space) using controls in the top toolbar:
-
Font settings – use these controls to configure the font (font family, font size, bold/italic/underline attributes, text color and alignment) of the selected object(s) that include text – functional blocks, ports, components, and texts.
-
Color – use these controls to configure the fill color (where applicable) and outline color of the selected object(s).
-
Line – use these controls to configure the line style and line weight of the selected object(s). This applied to line-type objects (connection line and polyline) and the outline of other objects.
To quickly apply the style from one object to another, you can select the object which style you want to copy, right-click in the design space and select the Copy Style command from the context menu (shortcut: Ctrl+Alt+C). To apply the copied style to one or more objects, select these objects, right-click the selection, and choose the Paste Style command from the context menu (shortcut: Ctrl+Alt+V).
You can also right-click an object and select the Set Default Style command from the context menu. The style of this object will be applied when placing subsequent objects of the same type.
Placed objects can be moved by selecting and dragging. Individual nodes can also be selected and moved to change the object's shape and/or size.
-
When dragging a node of a functional block, port, hardware component, software component, text, rectangle, or ellipse, hold Shift to maintain the object's aspect ratio.
-
When dragging a node of an image, its aspect ratio is maintained automatically. Hold Shift to disable this behavior.
Undoing and Redoing Operations
Use the Ctrl+Z and Ctrl+Y shortcuts to restore the ESD document to its state previous to the last operation and to restore changes made by the undo feature in the document, respectively.
Object Locking
Use commands of the Lock/Unlock submenu of an object's right-click menu to lock/unlock its size and position and/or content.
-
Lock / Unlock – use this command to lock/unlock the size and position of the object (so they cannot be changed graphically; an object with size and position locked also cannot be deleted), its style (i.e., its graphical appearance), and its content (e.g., the text of a functional block).
-
Lock size and position / Unlock size and position – use this command to lock/unlock the size and position of the object only.
-
Lock style / Unlock style – use this command to lock/unlock the style of the object only.
-
Lock content / Unlock content – use this command to lock/unlock the content of the object only.
If an object is fully locked (i.e., its size and position, style, and content are locked), a red dotted line will be shown around the object when it is selected. If some but not all aspects of an object are locked (i.e., its style only is locked), a yellow dotted line will be shown around the object when it is selected.
Accessing Object Properties
You can access properties of a placed object by selecting it in the design space and clicking the
button at the top right to open the Properties pane. Alternatively, right-click a placed object and select the Properties command from the menu that appears.
When no object is selected in the design space, the Properties pane shows properties of the ESD document itself – refer to the Document Properties section below to learn more.
The Parameters region of the Properties pane allows you to manage parameters of the selected object (functional block, hardware component, software component, port, or connection) or, when no object is selected, to the ESD document itself. In the Properties pane that opens, use
and
buttons to add and remove parameters, respectively.
Special Strings
While texts (text objects, names of functional blocks, etc.) can be used to display static, user-defined text in the ESD document, they can also be used as placeholders for document and object parameters. To use a special string in an ESD document, include a parameter name in the text of an object. Special strings are characterized by the prefix = (e.g., =ControlAlgorithm, =MotorType, etc.).
Multiple special strings, along with regular text (fixed strings), can be concatenated into a single text string, according to the following rules:
| Element |
Function |
Example |
= (equals) |
Indicates that the following string is an expression that must be interpreted. |
=MotorType ( ) |
+ (plus) |
Used to concatenate the special string and fixed string elements required in the string. |
=MotorType + NumberOfMotors ( ) |
' ' (single quotes) |
Used to include a fixed string anywhere within the required string. |
=MotorType + ' Motor (x' + NumberOfMotors + ')' ( ) |
If parameters with the same name are defined in the object and in the ESD document, the parameter value defined in the object overrides the value defined in the document.
Placing and Configuring Functional Blocks
To place a new functional bock in an ESD document, click the
button in the bottom toolbar. Click in the design space to anchor the first corner of the functional block's rectangle, then move the cursor to adjust the size of the rectangle and click again to complete placement. To change the name of a functional block, double-click the functional block, type the required name and press Enter or click outside the functional block.
To add a hardware component to a functional block, click the
button in the bottom toolbar. The cursor will change to a crosshair, with a component preview attached to it. Click within boundaries of a functional block to place the component. Double-click a placed component and use the search bar in the pop-up window that opens to search for a component. Select a component in the list of search results, and the name of this component will appear within the graphic of the functional block.
-
You can use the RA Explorer window to search for an MCU of the Renesas RA family. Refer to the Using the RA Explorer section below to learn more.
-
You can also place a hardware component outside of a functional block's boundaries. In this case, a new functional block will be created automatically.
-
Similarly, you can add a software component to a functional block.
To place a port within a functional block, click the
button in the bottom toolbar. The cursor will change to a crosshair, with a default port attached to it. Click within boundaries of a functional block to place the port. You can also click outside a functional block – in this case, a new default functional block will be created automatically. To change the name of a port, double-click the port, type the required name and press Enter or click outside the port.
When typing a port's name, you can also select a standard port name from the pop-up list that appears (
).
Using the RA Explorer
When searching for an MCU of the Renesas RA family, you can use the RA Explorer window to find the required component. Type RA or Renesas in the search bar after placing a hardware component and use the Explorer Mode link at the top of the pop-up to open the window where a list of suitable components will be presented. By default, the list will be constrained based on ports placed in the functional block. The current list of ports is shown at the top of the window. You can add ports of other types using the Add Port control and edit the required number of ports of each type using drop-downs. Click the required component in the list to select it and show its pin map in the right-hand side of the window. Click the
button when the required component is selected to apply it to the hardware component object.
If a functional block includes one or more ports with standard names (such as USB, ADC, etc.), the RA Explorer window can also be accessed from the Properties pane when a functional block (
) or a hardware component placed within that functional block (
) is selected. Once the required component is selected in the RA Explorer window, a hardware component will be automatically placed within the functional block (if not already), and the selected component will be applied to it.
Once an RA MCU is applied to the hardware component object, select it and open the Properties pane to explore its properties. You can click the
button to open the RA Explorer window and select another MCU if required.
Expand the Hardware Component Details region of the Properties pane for more information about hardware component parameters, ports, package info, and pin assignments. From the region, you can also add and remove ports, and the device configuration will be updated automatically if a compatible configuration is found.
Connecting Functional Blocks
A connection line can start and end at a functional block's boundary, a port's boundary, a rectangle's boundary, an image's boundary, another connection line, or free place of the ESD document. To place a connection line, click the
button in the bottom toolbar. Click the point at which you want to start the connection line. Position the cursor then click to anchor a series of vertex points that define the shape of the connection line. Note that the connection line will automatically avoid crossing functional blocks. Right-click to finish placement of a connection line in free space of the document. After placing a vertex on a functional block, port, or placed connection, placement of the current connection is finished automatically.
-
To start placing a connection line on the boundary of a functional block or port, you can also hover the cursor over the boundary (without selecting the block/port) and then click-and-drag when the cursor changes to a crosshair.
-
When a connection line starts or ends on another connection line, a T-junction (rendered as a small circle) forms automatically (
).
-
It is possible to connect two functional blocks using a straight connection line even if it starts in the off-grid middle of one of these blocks and should finish below/above the middle of another block.
When a placed connection line is selected, the following editing handles are available.
Either or both ends (source and target) of a connection line can be rendered with or without an arrow. When the connection line is selected, click the
button in the top toolbar and select the required style from the pop-up menu that appears.
-
When a connection line is selected, you can quickly toggle the source and target arrow using the Left Arrow and Right Arrow shortcut, respectively.
-
Note that a T-junction will be rendered without the circle if the connection line that starts or ends on another connection line has the arrow enabled on the junction.
Define a placed connection line's designator by double-clicking the connection line and entering the required designator. When a designator is selected, use the handle at the top right to rotate it (
).
You can pin a segment of a connection line by dragging the segment's editing handle or right-clicking the segment and selecting Pin Segment from the menu that appears. The editing handle of a pinned segment is rendered with blue filling (
). The current horizontal or vertical position of a pinned segment remains unchanged when other segments of the connection line are moved. To unpin a pinned segment, select Unpin Segment from the segment's right-click menu.
Placing Blankets
The ESD document editor allows you to place blanket objects into an ESD document to further document your system design. Hardware and software blankets can also be linked to a PCB or software project, respectively, to provide you with the context of a particular portion of your system design right in the ESD document.
Use the blanket object menu in the bottom toolbar to place a blanket (
), hardware blanket (
), or software blanket (
).
-
Blankets, hardware blankets, and software blankets can be placed as rectangular of polygon-shaped objects. After selecting the placement command:
-
To place a rectangular blanket, position the cursor then click to effect placement.
-
To place a polygon-shaped blanket, position the cursor then click and drag to anchor the starting point for the blanket and then click to anchor a series of segments that define the shape of the blanket. After placing the final segment, right-click to complete placement. There is no need to 'close' the polygon as the software will automatically complete the shape by adding required segments to connecting the start point to the final segment placed.
-
Note that a software blanket must be placed inside of a functional block.
To link a hardware blanket to a PCB project or software blanket to a software project, select the blanket in the design space and click the
button in the Properties pane. In the Select Project to link window that opens, select a project to be linked to the blanket and click the
button. Information about the linked project will appear in the Properties pane. Click the
button to open the linked project in a new browser tab.
Placing Text
The ESD document editor provides the ability to place text strings. Optionally, links can be added to text strings.
To place a text string, use click the
icon in the bottom toolbar.
To edit a placed text string, double-click it, enter the required text and press Enter or click outside the text object.
To add a link to a placed text, first select the required text object and then click the
button in the top toolbar. In the pop-up field that appear, type the required URL and press Enter.
The added link can be accessed by hovering the cursor over the text object and then clicking the link in the pop-up that appears.
To edit the link, click the
button in the pop-up, change the URL as required, and press Enter or click the
button to remove the link from the text object.
Placing Graphical Objects
The ESD document editor provides a range of graphical element tools that can be used to place basic, free-form drawing elements in an ESD document:
-
Rectangle (
)
-
Ellipse (
)
-
Line (
)
-
Image (
)
Use the graphical object menu in the bottom toolbar to place the required object.
After selecting the required command from the menu, place a graphic element by clicking and dragging in the design space to position and determine its size, such as the distance between opposite vertices for a rectangle. For a polyline, click to position its first vertex and then again to place following vertices, therefore determining its shape.
Placed graphical objects can be moved by selecting and dragging. Individual nodes can also be selected and moved.
Document Properties
When no object is selected in the design space of the ESD document, the Properties pane (accessed by clicking the
button at the top right) shows properties related to the ESD document itself.
-
If the solution that includes the ESD document was generated from an example, the Document Notes region of the Properties pane at the top presents a detailed description of the solution.
-
The Parameters region of the Properties pane shows the list of the ESD document's parameters. Use
and
buttons to add and remove parameters, respectively. Click a parameter's name or value to edit it.
-
The Documentation & Resources region of the Properties pane provides an automatically formed list of links to resources (Renesas documentation, PDFs) related to the solution and its elements.
Commenting
The ESD document editor supports commenting of your ESD documents. A comment is a user-added note that is assigned to a specific point, object, or area and may be replied to by other users. Comments promote collaboration between users without altering the shared data itself, because comments are stored by the Workspace independently of that data. Comments are posted, replied to, and managed directly within the document's design space using a contextual commenting window. You can mention one or more people or groups in the comment. A comment also can be assigned to a Workspace member.
To place a comment, use the
button in the right toolbar or the Add Comment command from the right-click menu of the document's design space.
Working comment in an ESD document is similar to working with comment in Altium 365's Web Viewer. For more information about the commenting system, refer to the Web Viewer page.
Sharing an ESD Document
An ESD document can be shared with view permissions to those outside of your Workspace. Click the
button at the top right of the ESD document to open the Share Item window. Select the Share Item With field to access and enter the full email address of the user. The user will have Guest-level access to the shared ESD document through their own Workspace or Personal Space.
Workspace members always have full editing access (Can Edit).
Managing an ESD Document
The menu of the
button menu at the top right of an ESD document allows you to manage the document using the following commands:
-
Settings – use this command to access the Edit Project window that provides the controls to change the ESD document's Name and Description (
). Click the
button to access the Parent Folder field and Workspace Parameters. The Parent Folder field is non-editable, providing information only. To change the parent folder, you need to use the Move command. Click the
button to confirm any changes you have made.
-
Move – use this command to access the Move to window that provides the controls to move (relocate) the ESD document under a different parent folder within the Workspace folder structure (
). Use the window to choose the new parent folder. Click the
button to effect the move.
-
Clone – use this command to access the Clone - ESD window that provides the controls to make an identical copy of the ESD document (
). Use the window to specify a name for the ESD document and an optional description. By default, the original document name will be used with the suffix – Copy.
Note that the cloned ESD document name should start with, and can contain A-Z, a-z, or 0-9. Underscores, dashes, and spaces are allowed, but the latter can only be used within the middle of the name (leading and trailing spaces will be ignored). You cannot use the following words: AUX, COM1-COM9, LPT1-LPT9, CON, NUL, and PRN. In addition, the name cannot contain the following characters: \ . / ? % * : | " < >. You cannot use the same name as the original document.
Click the
button to access the Parent Folder field. By default, this will be set to the folder in which the original document is located. Click the Change link at the right of the field to access the Workspace folder structure for the Workspace, from which to select an alternate folder in which to store the cloned document.
After setting the fields as required, click the
button, and the original document will be cloned (duplicated). The created copy of the ESD document can then be linked to the required solution from the detailed page of that solution in the Renesas 365 Workspace – learn more.
-
Download – use this command to download the ESD document as a *.json file.