.. _cgi_framework:


*****************
Beacon Framework
*****************

.. -implementing-cgibeaconframework


The CGI Beacon Framework is designed to make it as easy as possible to integrate location-based actions into your application. The framework can be set up with just a few lines of code and also includes an optional toolkit that contains UI controls for standard actions.


Architecture Overview
======================

Following is an overview of the different systems that are involved in the CGI Beacon Platform:

.. image:: _static/ArchOverview.png

Beaconplatform.io
==================

This is the web based administration panel that is used to set up your triggers and actions. This is where you decide what will happen when a user walks past an Beacon, or into a Geofence.

Triggers
============

A trigger is what initiates the action and can be either an Beacon or a Geofence.


Actions
=========

An action is the response to a trigger being activated. For example, showing a message to the user, opening a web page, or just logging the users presence.


Location Services
==================

This is the native API that the Mobile Device OS exposes through its SDK. 


CGI Beacon Framework
======================

This framework will integrate your app with the native location services API and set up monitoring for all triggers and deliver events to your application.