Home

Welcome to the PRiME Framework Wiki!

These pages are designed to help you take advantage of the PRiME Framework by documenting its functions, features and explaining how it can be used.

For more information on developing for a particular module, refer to the specific page:

• Application Development
• RTM Development
• Device Development

The Framework provides several modules which aim to make running and demonstrating experiments easier. These include a user interface (UI), a data logging (Logger) modules and a graphical visualisation (Visualiser) module. For more information on using each module, refer to the specific page:

• UI Information
• Logger Information
• Visualiser Information

Information about the formal verification of the interactions of the PRiME Framework's API can be found on this page: Formal Verification

Block Diagram

This block diagram illustrates the arrangement of the modules and API connections within the PRiME Framework.

Quick-start Instructions

Follow this set of instructions to get started conducting experiments with the PRiME Framework. This assumes a solid understanding of software installation under linux.

• Clone git repo to the platform: git clone https://github.com/PRiME-project/PRiME-Framework.git
• Enter the base directory: cd PRiME-Framework.
• Run the prerequisites script for your chosen device:
  • chmod +x prereq.sh && ./prereq.sh
• Create and enter build directory: mkdir build && cd build
• Invoke cmake to build the makefile: cmake ..
• Compile the project with the generated makefile: make -j8.
• Run the logger from the logger directory: cd logger/ && python logger.py
• Run the UI from the ui directory: cd ui/ && python3 ui.py

N.B.: You will need multiple terminals open to view the output from the logger and use the UI.

Software Prerequisites

General prerequisites include:

• git
• make
• cmake 2.8
• Python 3 + npyscreen package (installed with pip3)

Prerequisites for example platforms are given in the Device Development documentation.