UltraZohm components library

Before starting with the description and instructions on how to use the database system in Altium, a brief overview of the different tools is given.

Fig. 104 Overview of the databased system for Altium.

The library system splits up in three different locations:

1. The altium_libraries repository. All schematic symbols and PCB footprints of the individual components as well as the DbLib file that is required to connect to the database on the Ultrazohm server is located in this repository

2. The UltraZohm server: All component parameters like Manufacturer Part Numbers etc. are managed by a MariaDB database on the server. In order to edit database records a separate database client (e.g. DBeaver) is recommended.

3. User’s PC: The PC of the PCB developer gets access to the locations 1 and 2 and the developer is able to place the components. In case he has write access he can also edit and add components.

In the following, the individual tools and necessary installation steps are discussed.

Note

All usernames and passwords can be obtained from the UltraZohm core developer team. Please get in touch via the Slack channel!

In order to use the database driven library for Altium, a few settings need to be made initially. In the following chapters are a guideline on how to install and set the parameter is given. The following tools are required:

• Bitbucket

• ODBC Data Sources (64-Bit)

• Altium

• DBeaver

Videos of the setup

Note

The login information and user name in the videos do not match the real login data. Please get in touch via Slack to obtain the login information.

How to install Altium:

How to install the Altium library:

How to install DBeaver:

Bitbucket access setup

1. To work with the databased library system in Altium, it is necessary to get access to the Bitbucket system of the UltraZohm, especially to the altium_libraries repository

Fig. 105 Bitbucket - altium_libraries.

2. Clone the repository on your local computer

3. If you intent to add new components, create a new feature branch. Follow the naming convention feature/<meaningful_name>. If the git shell interface is used the command is git checkout -b feature/<branch_name>

4. If a new component was added, commit and push the new component to Bitbucket

5. When component editing is finished open a pull request on Bitbucket. The components will be reviewed and merged into the master branch.

Server access setup

Altium needs to get access to the database system on the UltraZohm server. The interface to the database is an ODBC database driver.

1. If not done yet download and install the MariaDB ODBC 3.1 Driver

Fig. 106 OBDC - download link.

2. Open the ODBC-Datasource App (64-Bit)

Fig. 107 OBDC - open App.

3. Add a new User-DSN

Fig. 108 OBDC - add user-DSN.

4. Select the MariaDB ODBC 3.1 Driver

Fig. 109 OBDC - select MariaDB.

5. Create a new data source to MariaDB. Use the predefined user “altium_user” and contact your supervisor for the access data.

Fig. 110 OBDC - create a new data source.

6. Connect it to the ultrazohm server

Fig. 111 OBDC - connection to ultrazohm server.

Note

The ODBC connection is read only because no changes on the database will be made from Altium directly. A separate database client e.g. DBeaver is used to edit the database (see Integration in Altium).

7. Do nothing and press Next >

Fig. 112 OBDC - skip.

8. Do nothing and press Next >

Fig. 113 OBDC - skip.

9. Force to use TLS and go back for three times < Previous

Fig. 114 OBDC - use TLS.

10. Select the database “altium_library” and Test DSN

Fig. 115 OBDC - select “altium_library”.

11. Finish the settings by pressing three times OK

Fig. 116 OBDC - finish settings.

Integration in Altium

1. Open a schematic document in Altium

2. Choose the point place –> part; a menu on the left or right side will open with the already installed library preferences called “components”

Fig. 117 Altium - component libraries.

3. Click on the three horizontal lines and select the point File-based library Preferences

4. Select the register Installed. While not necessary, it is strongly recommended to remove all not required libraries at this point (e.g. the standard “Miscellaneous Devices” library from Altium)

Fig. 118 Altium - installed libraries.

5. Select Install… and navigate to the path where the Bitbucket repository is cloned on the computer. Select the file “user.DbLib”

6. Close this window

7. After installing the DBLib - File, you can choose between the different integrated component tables

Fig. 119 Altium - different component tables.

8. Now you can use all already existing components from the databased library

Setup of the database client

If new components are required the developer will need write access to the Bitbucket repository and to the database on the UltraZohm server. A dedicated user called altium_developer is available on the database system for this purpose. He has write access to the whole library database. As a graphical database client DBeaver is recommended.

1. Download the Dbeaver software to work with the MariaDB on the UltraZohm server

2. Open DBeaver

3. Select MariaDB

Fig. 120 DBeaver - select mariaDB.

4. Connect it to the ultrazohm server

Fig. 121 DBeaver - general settings.

5. Download the MariaDB driver, which is recommended

Fig. 122 DBeaver - driver settings - 1.

6. These settings must be selected automatically after the download of MariaDB.

Fig. 123 DBeaver - driver settings - 2.

7. Select use SSL and uncheck Verify server certificate in the SSL tab

Fig. 124 DBeaver - SSL settings.

8. Click Finish. At this time, you are able to connect to the database

9. If the connection failed, control the settings and reconnect via right click on the altium_library –> Invalidate/ Reconnect

10. If the connection was successful, the following table structure must be visible

Fig. 125 DBeaver - table structure.

This step completes the initial setup.

Addition of a new component

In the following chapter the procedure to add a new component is illustrated by adding an SMD capacitor. The following chapter only explains the addition of the component to the repository and the database. Furthermore, the developer who adds the component has to make sure that the footprint follows the mapping of the mechanical layers. See Mapping of the mechanical layers for further information. If the component does not follow this mapping the pull request will not be accepted.

Note

The goal of this database system is that schematic and footprints of generic components only exist once. This means that schematics and footprints symbols of generic components only have to be in the Bitbucket repository once, even if there are multiple physical components available (e.g. different manufacturers and values). Only if the component has a different geometry or pinout, a new schematic and/or footprint must be added. The number of pins on the symbol must match the number of pins on the footprints. The mapping of the pins is done with the pin numbering (pin 1 of the symbol is mapped to pin 1 of the footprint and so on). In case of doubt the symbol and the footprint supplied by the manufacturer must be used instead of using an existing footprint.

1. Check if the schematic symbol already exists as a symbol in the Bitbucket system. The schematic symbols are located under alitum_libraries\symbols If the schematic does not exist, copy the schematic symbol in the suitable directory under alitum_libraries\symbols. It is vital that the .SchLib file only contains one symbol. See Symbols and Footprints on how to extract the symbol from different sources.

Fig. 126 Explorer - symbols.

2. Follow the naming convention for the .SchLib file SCH - <directory> - <description>.SCHLIB

Note

The extension of the file is written in capital letters.

3. Check if the footprint symbol already exists in the Bitbucket system. Use the IPC-7351B naming convention when searching for the footprint. If the component does not exist copy the footprint in the suitable folder of the footprints \alitum_libraries\footprints. It is vital that the .PcbLib file only contains one footprint. See Symbols and Footprints on how to extract the symbol from different sources.

Fig. 127 Explorer - footprints.

4. Follow the naming convention for the .PcbLib file PCB - <directory> - <description>.PCBLIB. Try to use the IPC-7351B naming convention for <description> and make sure to use the same name for the footprint name property which is used as Footprint Ref in the MariaDB.

Fig. 128 IPC-7351B name generation example for SOIC127P930X265-16.

Note

The extension of the file is written in capital letters.

5. Switch to the DBeaver tool

6. Choose a suitable table where the component should be added. If no table is suitable go on with the instruction given in section Addition of a new table.

Warning

This option must only be chosen after talking to your supervisor and must be announced in a pull request. When adding a new table, the .DbLib file, which implements the connection from Altium to the database, must be changed and all users need to update the file in order to get access to the new table. In case of doubt put the component in an existing table. The current amount of tables should be sufficient to fulfill the requirements.

Fig. 129 DBeaver - choose a suitable table.

7. A new register on the right side with the table will appear

Fig. 130 DBeaver - Editor will open on the right side.

8. Switch to the “Data” register. An overview of all already added components will be shown there.

Fig. 131 DBeaver - change to tab “data”. In this case, no component is still existing in the table.

9. Press the add button and a new row highlighted in green appears.

10. Double click on a cell to enter content.

11. To switch between the view of all components and the comfortable editing mode for one component –> press tab.

12. If all necessary cells are filled with information, save the components with the save button (under the current table on the left side or by pressing Ctrl + S). Some cells are constraint to be NOT NULL. These cells must be filled before saving is allowed. If those cells are not filled the following message will occur.

Fig. 132 DBeaver - error message.

Press OK and fill out the missing cell (in this example, “ComponentLink1Description”). The table cells, which are here described in detail is from “Capacitors - SMD” table as an example.

Table 64 Capacitors - SMD

Cell name	Value	Explanation	Must be filled
PartID	Automatically added
Created On	Automatically added
Comment	Value
ComponentLink1Description	datasheet	Homepage/ Datasheet	x
ComponentLink1URL	https://www.mouser.de/datasheet/2/281/c03e-516224.pdf	URL Link to homepage or datasheet	x
ComponentLink2Description		See “ComponentLink1Description”
ComponentLink2URL		See “ComponentLink1URL”
ComponentLink3Description		See “ComponentLink1Description”
ComponentLink3URL		See “ComponentLink1URL”
ComponentLink4Description		See “ComponentLink1Description”
ComponentLink4URL		See “ComponentLink1URL”
ComponentLink5Description		See “ComponentLink1Description”
ComponentLink5URL		See “ComponentLink1URL”
ComponentLink6Description		See “ComponentLink1Description”
ComponentLink6URL		See “ComponentLink1URL”
Component Type		Type of the component	x
Description		A descritption make the usage of the component easier to the designer	x
Device Package	603	0603/ 0805…
Footprint Path	footprints/Capacitor - Chip/PCB - CAPACITOR - CHIP - CAPC_0603.PCBLIB	Path were the footprint is saved	x
Footprint Path 2		See “Footprint Path”
Footprint Path 3		See “Footprint Path”
Footprint Ref	C_0603	Name in the Altium Library	x
Footprint Ref 2		See “Footprint Ref”
Footprint Ref 3		See “Footprint Ref”
Last Updated	Automatically added	Last Updated
Manufacturer	muRata	Manufacturer	x
Manufacturer Part Number	GCJ188R71H103KA01D	Manufacturer Part Number	x
Minimum Order		Minimum Order
Mounting Type	SMD	SMD/ THT
Operating Temperature	-55 - 125°C	Operating Temperature
Series	GCJ	Series
Supplier 1	Mouser	Supplier	x
Supplier Part Number 1	81-GCJ188R71H103KA1D	Supplier part number	x
Supplier 2		Supplier
Supplier Part Number 2		Supplier part number
Supplier 3		Supplier
Supplier Part Number 3		Supplier part number
Supplier 4		Supplier
Supplier Part Number 4		Supplier part number
Supplier 5		Supplier
Supplier Part Number 5		Supplier part number
Supplier 6		Supplier
Supplier Part Number 6		Supplier part number
Library Path	symbols/Passives/SCH - PASSIVES - CAPACITOR.SCHLIB	Path were the schematic symbol is saved	x
Library Ref	Capacitor	Name in Altium schematic library	x
Type	Standard	Altium component types see the Altium manual	x
Tolerance	10%	Tolerance
Voltage Rating	50 VDC	Voltage Rating
Value	0.01 µF	Value	x
Created from	MGremer	Designer
Verified by		Verfikator
Live Cycle Status	1	1: new design	x
		2: verified
		3: in use
LCSC Part Number		LCSC Part Number component description for ordering and assembly at JLC PCB
Stock number	Labor SMD Container	Stock number of the ELSYS component stock

13. If the component is saved in DBeaver, refresh the view in Altium via F5 –> choose place –> part and select the library where the component has been added –> the new component is shown with all the inserted database information

Fig. 133 Altium - component information - 1.

Fig. 134 Altium - component information - 2.

Fig. 135 Altium - component information - 3.

14. The component can now be used in the schematic by drag and drop or by selecting via right-click place ...

15. If the added component is not visible in the library, refresh via F5 again

16. If a new table was added in the database, open the user.DbLib File (also included in the Bitbucket folder)

Fig. 136 Altium - user.DbLib File.

17. At the end of the adding process of a component commit and to push the new components for other users in Bitbucket and open a pull request to the master branch.

Addition of a new table

Warning

This option must only be chosen after talking to your supervisor and must be announced in a pull request. When adding a new table, the .DbLib file, which implements the connection from Altium to the database, must be changed and all users need to update the file in order to get access to the new table. In case of doubt put the component in an existing table. The current amount of tables should be sufficient to fulfill the requirements.

If the component you intend to add does not fit in the existing tables a new table must be created. In the following this procedure is described:

1. Open the SQL Editor in DBeaver

Fig. 137 DBeaver - Open the SQL Editor in DBeaver.

2. On the Bitbucket system the sql File “create_tables.sql” is available

Fig. 138 Bitbucket folder - Open the sql File “create_tables.sql”.

In this file you can find the syntax for creating a new table.

3. Create the various relevant table columns by copying the following rows:

Fig. 139 DBeaver - Parameter - Part 1.

Edit only the name of the table (in this example: “Logic - Buffer and Driver”) to the new one. Copy all rows without editing

4. Add between the field “Type” and “Value” all categories specific values like “power loss”, “tolerance”, “voltage rating” etc.

Fig. 140 DBeaver - Parameter -Part 2.

5. Excute the sql statement

Fig. 141 DBeaver - Execute the sql statement.

6. Now it is possible to add new components to this table by following the instructions in section Addition of a new component.

7. If components were added to the table, it is necessary to change one setting in Altium for this table once. Therefore, open the “user.DbLib” file in Altium.

8. Select the necessary table.

9. Change under Field Settings the point Database field from “choose field” to Manufacturer Part Number

Fig. 142 Altium - Change database field.

10. Save the new settings in the “user.DbLib” file and commit it to the Bitbucket system for all the other users.