Skip to content

Latest commit

 

History

History
executable file
·
137 lines (110 loc) · 6.34 KB

README.md

File metadata and controls

executable file
·
137 lines (110 loc) · 6.34 KB
Raw

garage-client travis npm downloads JavaScript Style Guide

About

This is an example implementation of services and devices on the IOTA network using a weather station, FPGA, and a garage door opener. The IOTA network is still a young protocol with a lot of room for interpretation on how to best utilize it. While there have been attempts to market data for financial gain, I believe the more practical application lies in the sale of IoT devices with an ASIC POW chip to talk on the IOTA network effortlessly.

This demo client is essentially a tool to listen to the iota network and make decisions (open/close the garage door) based upon specified instruction sets and inputs that you can find in test/weatherProgram.json

Install

# yarn
yarn add @iftt/garage-client
# npm
npm i --save @iftt/garage-client

How to use

Create Environment file

create a file called .env with these keys and replacing the variables:

API_TOKEN=1234567890
CLIENT_SECRET=TEST9SECRET
CLIENT_TANGLE_SEED=0000JYXUUZVHMCDLNEFA9ZBRM00000PJFLEPMNEFWXOHCTVZWBLCLE9HUOLYLWS9NMJDOKQMOKINXQA
DEVICE_ID=477a5971-3e9d-4eae-98fe-22cb4c153dc1
SERVER=192.168.0.46:3001
GARAGE_OPEN_STATE=1

How to generate a unique device id secret

# Linux & OS X
uuidgen

How to generate a unique IOTA seed

# Linux
cat /dev/urandom |tr -dc A-Z9|head -c${1:-81}
# OS X
cat /dev/urandom |LC_ALL=C tr -dc 'A-Z9' | fold -w 81 | head -n 1

Create the client

Option 1: download this repository and run from the lib

# clone the repo
git clone https://github.com/iftt/garage-client.git
# install dependences
yarn # or npm install
# run the client
node runGarageClient.js

Option 2: install the npm package and run

After installing the package, create a JS file and input the following

// ES6
import '@iftt/garage-client'
// ES5
const GarageClient = require('@iftt/garage-client').default

new GarageClient({
  tangleLocation: 'https://nodes.devnet.iota.org',
  fpgaPort: '/dev/ttyUSB1'
})

Modules

These are some of the main modules that make up the IFTT project:

module tests version description
garage-client IFTT Server (this module)
tryte-encode-decode data<-->trytes
tryte-buffer json<-->Trytes
program-generator create programs from user defined json
icc-fpga-protocol POW with an fpga device

Debug

If you need to debug this module use the string garage-client & service-manager (to be modularized)

DEBUG=garage-client,service-manager,icc-fpga-protocol,tryte-buffer,tryte-encode-decode node x
# or all
DEBUG=* node x

ISC License (ISC)

Copyright 2019 Copyright (c) 2004-2010 by Internet Systems Consortium, Inc. ("ISC") Copyright (c) 1995-2003 by Internet Software Consortium

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.