Skip to main content

Introduction

note

This documentation is for GSI Aurora software v4.4.x and newer.

Color​

GSI Aurora provides comprehensive support for defining colors across all label objects, allowing for advanced customization and flexibility. The Web UI features a user-friendly color selection tool that makes it easy for users to pick and apply colors as needed. For those who wish to define colors manually or require more in-depth customization, detailed guidelines and specifications on how to accurately define and format colors are documented thoroughly here:

Dynamic text​

GSI Aurora offers robust support for advanced dynamic text capabilities, enabling users to incorporate elements such as variables, date/time stamps, counters, and more. These dynamic text features can be utilized through an intuitive, easy-to-learn language designed to simplify the process of creating complex text behaviors. To help users make the most of this functionality, the dynamic text language is thoroughly documented with numerous examples and use cases provided here:

Protocol (API)​

GSI Aurora can be accessed remotely, or from extensions, using two different protocols: REST and Aurora-API. Note that in some situations it makes more sense to call these protocol APIs.

The REST (Representational State Transfer) API is a popular architectural style for building web services. It provides a set of conventions and best practices that make it easier for developers to build, use, and maintain web-based systems. Although REST APIs are designed to be straightforward, using them still involves a lot of repetitive tasks, like setting up requests, handling responses, and working with data. A client library helps simplify all these tasks by taking care of the technical details, making it much easier and faster to use the API.

The other API is the Aurora API, a text-based protocol designed for ease of use, especially when working with devices that lack an HTTP client library. Due to its minimal overhead, the Aurora API offers significantly faster performance. Additionally, several low-level requests are exclusively accessible through the Aurora API.

Both protocols are documented here:

Both of these protocols use JSON extensively for data exchange. Since the JSON objects are shared between the REST and Aurora API, they are documented separately here:

Legacy documentation​

The following protocols are deprecated, and should not be used for new projects: