https://github.com/circuit/node-red-contrib-circuit

Official node-red extension for the Circuit SDK (circuit-sdk)
https://github.com/circuit/node-red-contrib-circuit

circuit circuit-sdk node-red unify

Last synced: about 1 month ago
JSON representation

Official node-red extension for the Circuit SDK (circuit-sdk)

• Host: GitHub
• URL: https://github.com/circuit/node-red-contrib-circuit
• Owner: circuit
• License: other
• Created: 2016-12-22T11:06:44.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2023-01-24T01:17:46.000Z (almost 2 years ago)
• Last Synced: 2024-04-12T15:37:02.503Z (9 months ago)
• Topics: circuit, circuit-sdk, node-red, unify
• Language: HTML
• Homepage:
• Size: 564 KB
• Stars: 1
• Watchers: 8
• Forks: 2
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# node-red-contrib-circuit

This node-red-contrib-circuit is simple [Node-Red](http://nodered.org) git ui that allows you to easily integrate the functionality of the circuit sdk into your applications using node-red.

## Pre-requisites

[![NodeRed](https://img.shields.io/badge/Node--Red-0.18.7-red.svg)](http://nodered.org)

[![NodeJS](https://img.shields.io/badge/Node.js-6.10.2-brightgreen.svg)](https://nodejs.org) 


Requires [Node-Red](http://nodered.org) version 0.18.7 or more recent.


Requires a [https://circuitsandbox.net](https://circuitsandbox.net) account with a bot to host the application with OAuth `client_credentials`.

## Installations

Make sure you have NodeRed installed on your machine, if not you can install it by running the below command. 


    `$ npm install -g --unsafe-perm node-red` 


Then you can start node-red by typing `node-red` in the command lind. More information on node-red can be found 


at the node-red github [here](https://github.com/node-red/node-red).

### Installing node-red-contrib-circuit

Either install via pallette or via "npm install".


    `$ npm install node-red-contrib-circuit` 


Run the following command for global install. 


    `$ npm install -g node-red-contrib-circuit` 


## Getting started

1. Install both `node-red` and `node-red-contrib-circuit` as displayed above.

2. Once both packages are installed you will need a bot with OAuth client_credentials to run your application with.


You can go [here](https://circuit.github.io/) and follow the instructions to obtain your credentials.

3.  Start node-red by typing `$ node-red` into the command line and wait for the server to be loaded. After node-red is running you should be able to go to `localhost:1880` to view your node-red server. If the node-red-contrib-circuit has been installed properly you should be able to scroll through your nodes and view the available API nodes to use.

4. Once everything else is working you can follow the instructions in the Usage section.

## Usage

1. Select node with API functionality you desire.

2. Enter the circuit-server information needed for bot, such as: `client_id`, `client_secret`, `domain`.

3. Additional information on circuit client can be found at: [https://github.com/circuit/circuit-sdk](https://github.com/circuit/circuit-sdk).

## Applications

You can easily make applications using node-red and integrate them with our node-red-contrib-circuit API nodes. If you go [here](https://flows.nodered.org/flow/a9bcf02ec768ee9e8f3373808e0103e7) you can find an example flow that creates a bot to listen to a conversation and will send requests to look up weather, define words, and tell you jokes.

## Testing

Under development...