Skip to content

Latest commit

 

History

History
151 lines (119 loc) · 5.14 KB

README.md

File metadata and controls

151 lines (119 loc) · 5.14 KB

Collaborizm Mixpanel IoT Project

A project on Collaborizm to download and use Mixpanel Event data on IoT devices.

Read more at the repo root README.

 

Node.js Server (PC or RPi)

Downloads data from Mixpanel server and saves it in the Local Database at regular intervals.

 

Configuration

1. Mixpanel Event Schema (Example)

File: mixpanel.js (line 19)
Data sent to Mixpanel by Collaborizm server (and this node, for testing purposes).

Important: Add property timestamp to your Mixpanel event, with the value UNIX timestamp (ms).
Mixpanel REST API does not have required constraints to fetch distinct data. So we need this. PERIOD

mp.track("Reply", {
  city: "Mangalore",
  country: 'India',
  date: moment(Date.now()).format(),	// Human readable date
  timestamp: moment(Date.now()).valueOf()	// (important) unix timestamp in ms
});

2. Local Database Schema

File: db.js (line 43)
How our Local Database stores data imported from Mixpanel.

Important: Do not remove timestamp.
Mixpanel REST API does not have required constraints to fetch distinct data. So whatever you do, just don't touch it. PERIOD

db.eventSchema = new Schema({
  name: {type: String, required: true}, // event name
  city: {type: String, required: true},
  country: {type: String, required: true},
  date: {type: Date, default: moment(Date.now()).format()}, // human readable date, ISO 8601
  timestamp: {type: Number, default: moment(Date.now()).valueOf()}	// (important) unix timestamp in ms
});

3. API Keys

File: config.js
Sign up and use API keys for Mixpanel and MongoDB (if not using local DB).

4. Local Server

File: webserver.js
Configure port and other web server related stuff, including REST API paths.
Default port is 8970, subject to change.

 

REST API

1. http://server_ip:8970

REST API Server. Default port is 8970, subject to change.
Watch node console to catch it.

2. /

Status check.

3. /events?

JSON array of all events judged by following parameters.
Parameters:

name: Single or comma separated event names
cols: Single or comma separated projection. Default: "name, city, country, date, timestamp"
from: unix timestamp (ms) start
to: unix timestamp (ms) end
last: latest event only (single), can be combined with above params. Supply with dummy value.

4. /events/arduino

JSON Object containing line data. Directly displayed on Arduino without processing.
Deprecated: Formatted string for Arduino. Hack to get around low memory problems.
Output: The character (ASCII 30) prepended to the JSON string is used to determine the start of content.

�{"0": "<line 0 text>", "1": "<line 1 text>"}

5. /time

Server time. Used to set time for RTCs in client devices.
Output:

Human readable date and time. Not ISO 8601 time.

 

Build Instructions for PC

  1. Install Node.js
  2. Get API keys from Mixpanel and MongoLab.
  3. Open Command Prompt or Terminal console.
  4. cd to this directory.
  5. npm install -g nodemon
  6. npm install
  7. npm run dev
  8. Note down Local IP address displayed in the console.
  9. To exit, press Ctrl + C and y in the console. Else, nodemon will crash.

 

 

Raspberry Pi 2 Setup

For best results, flash latest Raspbian Jessie with Pixel image from Raspberry Pi website.

 

Hardware Setup

Raspberry Pi 2 Pin Layout

Name Connects to
Pin 2 (5V) I2C LCD GND
Pin 6 (GND) I2C LCD VCC
Pin 3 (SDA1) I2C LCD SDA
Pin 5 (SCL1) I2C LCD SCL

 

Install Node.js 7.x

Follow the instructions given by Dave Johnson.

 

Enable I2C Interface

There are two possible ways of doing this.

  • sudo raspi-config > Advanced Options.
  • Applications Menu > Preferences > Raspberry Pi Configuration > Interfaces

 

Install and Configure App

  1. Create directory /home/pi/mixpanel_iot_server.
  2. Copy all individual JS source files to this directory.
  3. cd /home/pi/mixpanel_iot_server
  4. sudo npm install -g nodemon
  5. sudo npm install
  6. sudo npm install lcdi2c
  7. sudo chmod +x start.sh
  8. Scan for I2C interface address of LCD using i2cdetect -y 1.
  9. Replace rpi.LCD_address in rpi.js with the output address.

 

Start App

  • To start from source directory, sudo ./start.sh
  • To start from other directories, sudo /home/pi/mixpanel_iot_server/./start.sh