Box libraries panel¶

The Box libraries panel displays the currently opened Box libraries:

../../../_images/chore-box-library-panel.png

The table below describes the main parts of the Box libraries panel:

Part

Name

Description

A

Tabs

Display all opened Box libraries and the Search panel.

Choregraphe includes and opens by default a Box library named standard which is read-only. It contains all the elementary boxes you need to create your first behaviors. Those boxes are ordered by their category of action (motion, LEDs, etc) or their function in the diagram (flow control, templates of boxes, etc).
The Search Tab enables you to search a specific box among all the opened box libraries.

B

Selected Box

Each Box is represented with its name and its image.

C

Tooltip

Displays the description of the selected box.

How to use A Box library¶

You can drag and drop any of the boxes contained in a Box library onto the Flow diagram Panel to enrich a Behavior or a Box.

Available Box Libraries¶

In addition to standard box library, two other Box Libraries are available:

Advanced: offers advanced alternative to standard boxes in order to go further in mastering behaviors.
Deprecated: lets you know which boxes has been deprecated since the last release.

How to open a Box library¶

Step	Action
	Choose Box library > Open box library....
	Select the relevant file type: Directory for the Box libraries delivered in release 1.14, .clb for the former Box Libraries. For further details, see: Box library available formats.
	Select the Box library to open.
	Click Choose to validate your choice.

How to customize the Box libraries¶

You can create or open your own Box library through the Box library menu.

It is then possible for you to customize your Box library:

Add a box from the Flow diagram to your library by right-clicking on the box in the Flow diagram and select Add to library.
Copy a box (or a folder) from an other box library by right-clicking on it and selecting Copy, then paste the box (or the folder) into yours by right-clicking in your box library and selecting Paste.
Edit the name, the description and the image of a box contained in your box library by double-clicking on it in the box library panel or right-clicking and selecting Box properties.
Move a box (or a folder) around.
Create a new folder by right-clicking in your box library and selecting Create Folder.
Rename a folder by double-clicking on it in the Box library panel or right-clicking and selecting Rename.

You can then save or close the opened box library by selecting it (left-click on the tab corresponding to the concerned box library) and then going to the Box library menu to select the action you want to make (save or close).

Note

Note also that the opened box libraries are automatically saved when you exit Choregraphe.

To automatically open your own box libraries at Choregraphe startup:

Choose Edit > Preferences.
Choose the box libraries you want to be opened in the field User’s box libraries.

What is a Box library¶

A box library consists of a list of Boxes.

This list can be organized with directories in order to sort boxes by category for example.

Each box may have attached files (music, image, etc) also included in the box library.

A box library is particularly useful when you often use the same boxes. You can store it in a box library and use and reuse it later.

Box library available formats¶

You can save / open a Box library as:

a single compressed file with a CBL extension (ex: MyLibrary.cbl). The box library CBL format is an easy way to archive a box library and / or release it to someone else.
a directory. The box library directory format is a very useful way for collaborative / versioned project whose can be modified and extended by many people.

Note

For further details about saving a project as a CRG file or as a directory, see How to save a box library as a CBL and How to save a box library as a directory.

In versions older than 1.10, box library files were not compressed (the extension was XAL).

How to save a box library as a CBL¶

Step	Action
	Choose Box library > Save box library as.... A new window titled “Save box library as...” is displayed:
	Make sure the file type is *Choregraphe box library (.cbl)**.
	Browse the destination path and complete the “File name” field.
	Click Save to validate your choice.

How to save a box library as a directory¶

Step	Action
	Choose Box library > Save box library as.... A new window titled “Save box library as...” is displayed:
	Make sure the file type is Box library directory (Directories).
	Make sure you have an empty folder and select it.
	Click Choose to validate your choice.

NAO Software 1.14 documentation

Box libraries panel¶