A brief walkthrough of the various components of Libre core
The software contained in this project, and the images pulled by the docker-compose file contained in this repo are pre-release versions and are not intended for production environments. Use of this software is at your own risk.
If you would like to use Libre in a production environment, please get in touch with Libre Technologies to ensure you have the correct stable versions of services for you specific needs.
Found at http://localhost
Libre admin is the primary component of Libre core, it is the centrepoint of all user driven activity.
Every time you login you should be greeted with an empty screen
You can access the menu by clicking the top left hand corner of the screen, and configure it through Security -> Menu Config
You can add new pages by clicking the + next to Menu Configuration Panel
If you click the checkbox Is Page, the drop down menu Menu Page will appear where you can select the type of page to add
From the menu configuration panel, you can also drag and drop pages or sections around
Navigate to Configuration -> Units of Measure
To create a unit of measure, click the + next to the search bar
Set up some variables of your choice and press save
Navigate to Configuration -> Equipment Classes
You should be able to see some preconfigured examples, and you can create a new one by clicking the +
You can configure the various aspects of the equipment class through the top toolbar
In the general tab you can edit the name an description of the class
In the properties tab you can set up properties for the class. Click the + next to the search bar to start writing a new property and press save when you're done
In the events tab, you set up triggers for Libre to record various states of the equipment.
Breaking down this image we have a few different fields
- Event Name - the name of the event being established
- Message Class - specifies the type of event. Here we use PerformanceLog as it is a measurement of the run rate of the machine
- Trigger Property - the property that causes the data to be written
- Trigger expression - the trigger that causes the data to be written. * The example provided here means that the edge will be monitoring the Rate property of any connected equipment, and when the Rate > 1, will trigger the expression
- Field properties - configures the fields that get written to the database * This can be properties and/or user defined fields
In the reasons tab you can add downtime reasons similarly to how you would add properties. Once you add a reason, whenever you add another reason you can assign it as a parent reason as follows
Here, the reason we are creating would have Lunch as its parent.
Navigate to Configuration -> Equipment
You can add an equipment similarly to the menu config or equipment classes page
Set up all the variables for the equipment and click add
An equipment will inherit all properties and reasons from its equipment class, and you can create new ones specifically for that equipment simiarly to how you would do it in equipment classes
Found at http://localhost:3000
A sample grafana dashboard to visualise some sample data in the influx database
Found at http://localhost:4000/graphql
Here is a graphql endpoint that allows you to talk directly with the primary database and see the structure of the schema. Note that this will be disabled in a production environment.
Found at http://localhost:8086
Here is an endpoint that allows you to directly interact with the influx database where the events described in the equipment class are stored.
Found at http://localhost:18083
Enables you track all the MQTT connections in the service