Preface
Welcome to the OrBIT User Guide. This guide describes how to use the OrBIT command line application to generate product package files for provisioning hardware devices. This guide also gives a brief introduction to the IAR Embedded Secure IP system, of which OrBIT is a part.
How to use this guide
The information in this guide is typically divided into different sections based on information types:
Concepts, which describes the topic and gives overviews of features related to the topic area. Any requirements or restrictions are also listed. Read this section to learn about the topic area.
Tasks, which lists useful tasks related to the topic area. For many of the tasks, you can also find step-by-step descriptions. Read this section for information about required tasks as well as for information about how to perform certain tasks.
Reference information, which gives reference information related to the topic area. Read this section for information about certain features or components.
What this guide contains
A brief outline of this guide:
Introduction to the IAR Embedded Secure IP system.
Using OrBIT describes the installation process for OrBIT and provides an overview of OrBIT and how it is intended to be used. It also includes troubleshooting tips.
Reference information gives reference information about the OrBIT options and commands, and about configuration fields.
Other documentation
User documentation is available as HTML5 and hypertext PDFs.
User guides
Information about:
Using the OrBIT command line application to create product packages for device provisioning is available in this guide.
How to register the IAR products is available in the Licensing Guide.
Using the Secure Deploy – Prototyping system to provision a device using a Security Appliance and a hardware programmer is available in the Secure Deploy – Prototyping User Guide.
Using the Security Appliance is available in the Security Appliance User Guide.
Using the Secure Deploy – Manufacturing software to install product packages and perform maintenance on Security Appliances in a high-volume production system is available in the Secure Deploy – Manufacturing User Guide.
Using the I-jet debug probe hardware programmer is available in the IAR Debug Probes User Guide.
Note
Additional documentation might be available depending on your product installation.
Web sites
Recommended web sites:
The IAR web site, www.iar.com, for information about Embedded Secure IP and Secure Deploy, and tips about IoT security. Here you will also find application notes and other product information.
The web site of the IoT Security Foundation, www.iotsecurityfoundation.org, for news and publications related to IoT security.
The JSON web site, www.json.org, for information about the JSON standard.
Document conventions
When referring to a directory in your product installation, the full path to the location is assumed, for example c:\Program Files (x86)\Secure Thingz Ltd
Typographic conventions
The IAR documentation set uses the following typographic conventions:
Style | Used for |
|---|---|
• Source code examples and file paths. • Text on the command line. • Binary, hexadecimal, and octal numbers. | |
A placeholder for an actual value used as a parameter, for example | |
An optional part of syntax description, where [ and ] are part of the actual command/option/field syntax. | |
An optional part of a syntax description. | |
| An optional part of a syntax description with alternatives. |
| A mandatory part of a syntax description with alternatives. |
Names of menus, menu commands, buttons, and dialog boxes that appear on the screen. | |
• A cross-reference within this guide or to another guide. • Emphasis. | |
… | An ellipsis indicates that the previous item can be repeated an arbitrary number of times. |
Identifies helpful tips and programming hints. | |
Identifies warnings. |
