Git Product home page Git Product logo

pinotify's Introduction

PiNotify project

PiNotify seeks to provide a way to notify and send short (140 character) messages via a tablet display, along with physical blinking lights and a physical button.

The flashing lights will blink until the message is acknowledged.

See PiNotify Design.py for more details about the project design.

Disclaimer

This is not an official Google product.

Setup

The project consists of 3 apps that work in concert: a backend and web UI that runs on Google AppEngine, an Android app that runs on the tablet, and a Raspberry Pi app that controls the lights and physical button based on Bluetooth commands from the tablet.

Before the AppEngine and Android apps can be built and run, some setup is required. Most of this setup involves creating keys for Firebase Push Notifications and Google Cloud Endpoints, which are used to allow the Android app to communicate with the backend.

Comments marked in the code with SETUP_TODO are things that need to be done to build, run, and deploy.

Some of this setup can probably be simplified in the future.

Setup steps:

  1. Create a Google Cloud Platform project and enable AppEngine on https://console.cloud.google.com.
  2. cd appengine
  3. mkdir lib
  4. pip install -t lib google-endpoints --ignore-installed
  5. Follow the instructions at https://firebase.google.com/docs/cloud-messaging/android/first-message to setup Firebase Cloud Messaging and add it to the Android app. This should replace the placeholder file app/google-services.json. You can link your Firebase project to your Google Cloud Platform project.
  6. Follow https://cloud.google.com/endpoints/docs/frameworks/legacy/v1/python/getstarted/backend/setup to setup Google Cloud Endpoints.
  7. In app/src/main/java/com/pinotify/BackendService.java, enter the Cloud Endpoints audience.
  8. In appengine/api.py, enter the Android and web client IDs from your project's Cloud Console credentials section.
  9. In appengine/web_handlers.py, add your Firebase cloud messaging API key.
  10. Follow the instructions on https://cloud.google.com/endpoints/docs/frameworks/legacy/v1/java/generate-client-libraries-android to create a client library for Android. Place it in a lib/ subdirectory of app/.
  11. When you launch the Android app, you'll need to enter the backend service URL. This can either be your local development server on the same WiFi, or your deployed backend URL.

pinotify's People

Contributors

caraitto avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  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.