Git Product home page Git Product logo

predix-machine-templates's Introduction

predixmachine-starter bundles

This repository holds the various machine starter bundles.

Each starter bundle has quickstart.sh script that sets up Predix services in the cloud, builds the bundle and injects it into the pre-configured Predix Machine tar ball so that you can quickly get started sending data from Predix Machine to the cloud and visualize the data in a UI.

Follow the tutorials for Edge Starters.

  • Scroll down, look for Edge Starters and choose the device you are interested in.

Customize a predix-machine-template-adapter

If you don't see an Edge Starter for a board you are interested in you can easily create one by following the example in the repo predix-machine-template-adapter.

  1. git clone https://github.com/PredixDev/predix-machine-template-adapter.git
  2. In the template project, review the quickstart.sh script. Notice the call to the predix-scripts/quickstart.sh script that handles much of the heavy lifting for you.
  • quickstart.sh -smf
    • Logs in to your Predix Cloud space
    • Creates a UAA and a client-id and a user
    • Creates a Time Series instance and add authorities to the client-id
    • Creates a Predix Asset instance and add authorities to the client-id
    • Creates a simple UI NodeJS app to view the data
    • Downloads a Predix Machine
  • apply the device specific changes - this is where you can customize the quickstart script to your devices needs
    • SampleDataNode.java - You can configure the device apis to connect to sensors
    • SampleMachineAdapter.java - You have to implement the readData method to read data from the sensor using your device api
  • quickstart.sh -t
    • Tar (zip) up the Predix Machine with the device specific behavior
    • Copies the tar to the device
  1. Review the contents of the config folder. This is where important property files for Predix Machine are located and your script can replace those files in the downloaded Predix Machine.
  2. Review and change the MachineAdapter.java file to retrieve data from the Device APIs and forward that data to the Spillway.
  3. Contribute the Starter back to us and we can share it in the community
  • Post a github Issue here and we'll take a look!

Device specific template repos

  1. Adapter Framework - https://github.com/PredixDev/predix-machine-template-adapter
  2. Adapter for Edison - https://github.com/PredixDev/predix-machine-template-adapter-edison
  3. Adapter for Raspberry Pi - https://github.com/PredixDev/predix-machine-template-adapter-pi

Analytics

predix-machine-templates's People

Contributors

katyatalluri avatar susheelvc avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.