Lampix Apps API
  • Introduction
  • Application Development
    • Getting Started
      • Up and Running
      • Boilerplate
    • Step by step app
      • What We'll Build
      • Environment Setup
      • Styling
      • HTML Structure
      • NeuralNetworkClassifier
      • MovementBasedSegmenter
      • Final Step
      • Extras
    • LampixJS
      • API Reference
        • Watcher
        • RegisteredWatcher
        • .watchers.add
        • .watchers.remove
        • .watchers.pauseAll
        • .watchers.resumeAll
        • .presets.button
        • .helpers.rectangle
        • getLampixInfo
        • switchToApp
        • exit
        • getApps
        • getAppConfig
        • getAppMetadata
        • writeJsonToFile
        • readJsonFromFile
        • transformRectCoords
        • constants
      • Examples
        • NeuralNetworkClassifier: Buttons
        • MovementBasedSegmenter
        • Counter App
      • Migrating from v0.x.x to v1.0.0-beta.x
      • Ecosystem
    • Deploying
      • Application Structure (production)
      • Local Deploy
    • Standard Watchers
    • Custom Watchers
      • Description
      • Environment Setup
      • Directory Structure
      • End result
      • QRCodeDetector implementation
    • Community
  • Lampix Simulator
    • Installation
    • Usage
      • Basics
Powered by GitBook
On this page
  • Prerequisites
  • Download
  • Linux only
  • Using the sample app
  • Loading it inside the simulator
  • Selecting watchers and the recognized class

Was this helpful?

  1. Application Development
  2. Getting Started

Up and Running

PreviousGetting StartedNextBoilerplate

Last updated 6 years ago

Was this helpful?

This guide is a short introduction into running an application inside the simulator. For a more detailed overview on how to create an application for Lampix, see the guide.

Prerequisites

  • Node.js and NPM (via , recommended for Windows, or via , recommended for Linux and macOS)

Download

Linux only

  • chmod +x <path-to-AppImage>

  • Run

Using the sample app

git clone https://github.com/lampix-org/minimal-sample.git
cd minimal-sample
npm install
npm start

This will start a development server at http://localhost:8080, provided that port is free to use. Otherwise, check the terminal output to find out the URL to go to.

Loading it inside the simulator

  • Start the simulator

  • Enter the URL in the address bar at the top of the simulator

  • Press Enter or the Load button

If the URL is valid, a new window with the simulated app will open.

Selecting watchers and the recognized class

The sample app uses finger detection, which corresponds to NeuralNetworkClassifier as the watcher name, with 0 as no finger detected and 1 as finger detected.

Steps:

  • in the main window (the one used to load apps), open the expansion panel in the middle that says Simulator <your-url>

  • select NeuralNetworkClassifier as the watcher name

  • select 1 as the recognized class

  • in the simulated app window, click the "Increase Count" button

Note that you will only be able to use 1 once until you use 0 to deactivate the button.

step by step application
installer
node version manager
Windows
macOS
Linux