openube / meshblu-rolling-spider Goto Github PK

meshblu-rolling-spider

A Meshblu connector for use in Octoblu or with other services.

Setup Instructions

Travis

1. gem install travis
2. travis login

Travis (S3)

For use if you need to push your browserified version

1. travis encrypt [S3_ACCESS_KEY_SECRET]
2. add the generated key to the .travis.yml file under secret_access_key in the s3 deploy section.
3. also add the s3 access_key_id to the same section

End result should look like this:

deploy:
  - provider: s3
    access_key_id: [S3_ACCESS_KEY]
    secret_access_key:
      secure: [S3_ACCESS_KEY_SECRET]
    bucket: [UPLOAD_BUCKET] # octoblu-cdn
    region: us-west-2
    skip_cleanup: true
    detect_encoding: true
    local-dir: deploy
    upload-dir: [UPLOAD_FOLDER] # js
    on:
      tags: true
      all_branches: true
      node: '0.10'

Travis (NPM Deploy)[http://docs.travis-ci.com/user/deployment/npm/]

1. travis encrypt [NPM_ACCESS_KEY] - this key is found in ~/.npmrc
2. add the generated key to the .travis.yml file under api_key in the npm deploy section.
3. also add the npm email to the same section

End result should look like this:

deploy:
  - provider: npm
    skip_cleanup: true
    clean_up: false
    email: [NPM_EMAIL]
    api_key:
      secure: [NPM_ACCESS_KEY]
    on:
      tags: true
      all_branches: true
      node: '0.11'

Usage

Gateblu Installation

Use (gateblu)[https://gateblu.octoblu.com/] to run this as a device.

Manual Installation

1. npm install meshblu-util -g
2. npm install meshblu-rolling-spider or git clone [GIT_URL]
3. go into connector folder
4. meshblu-util register -t device:meshblu-rolling-spider > meshblu.json
5. meshblu-util claim
6. npm start or to start with debug DEBUG='meshblu-rolling-spider*' npm start

Platform Dependencies

Edit the package.json to change the platformDependencies. This will show up when installing the connector in Octoblu and Gateblu.