Skip to content

Commit 32796dd

Browse files
knollearyknolleary
committed
Got to start somewhere
0 parents  commit 32796dd

155 files changed

Lines changed: 21836 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
node_modules
2+
credentials.json
3+
flows*.json

‎.nodemonignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
.git/*
2+
*.json
3+
lib/*

‎INSTALL‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
Node-RED Install
2+
================
3+
4+
## Install node.js
5+
6+
You can get the latest version from <http://nodejs.org/download/>.
7+
8+
Or, you may want to use a version from your operating system's package manager:
9+
<https://github.com/joyent/node/wiki/Installing-Node.js-via-package-manager>
10+
11+
## Install the pre-requisite modules
12+
13+
From the top-level directory of Node-RED, run:
14+
15+
$ npm install
16+
17+
This will install the core pre-requisite modules.
18+
19+
## Run Node-RED
20+
21+
From the top-level directory, run:
22+
23+
$ node red.js
24+
25+
You can then access Node-RED at <http://localhost:1880>.
26+
27+
Online documentation is available at <http://node-red.github.io/docs>.
28+
29+
## Installing individual node dependencies
30+
31+
When Node-RED starts, it attempts to load the nodes from the `nodes/` directory.
32+
Each will have its own set of dependencies that will need to be installed before
33+
the node is available in the palette.
34+
35+
To help identify the dependencies, Node-RED logs any modules it fails to find
36+
for a particular node. You don't have to install these unless you want or need
37+
that node to appear.
38+
39+
Alternatively, a node's `.js` file can be examined to identify the modules it
40+
explicitly requires. For example, the Twitter node is defined in
41+
`nodes/social/27-twitter.js` and contains:
42+
43+
var RED = require("../../red/red");
44+
var ntwitter = require('ntwitter');
45+
var OAuth= require('oauth').OAuth;
46+
47+
Of these, `ntwitter` and `oauth` are neither built-in modules nor ones provided
48+
by Node-RED itself. They can subsequently be installed by running:
49+
50+
$ npm install ntwitter oauth
51+

‎LICENSE‎

Lines changed: 177 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,177 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS

‎README.md‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Node-RED
2+
3+
A visual tool for wiring the Internet of Things.
4+
5+
## Quick Start
6+
7+
Check out [INSTALL](INSTALL) for full instructions on getting started.
8+
9+
1. download the zip and unzip, or git clone
10+
2. cd node-red
11+
3. npm install
12+
4. node red.js
13+
5. Open [http://localhost:1880]
14+
15+
## Browser Support
16+
17+
The Node-RED editor runs in the browser. We routinely develop and test using
18+
Chrome and Firefox. We have anecdotal evidence that it works in IE9.
19+
20+
We do not yet support mobile browsers, although that is high on our priority
21+
list.
22+
23+
## Contributing
24+
25+
### Reporting issues
26+
27+
Please raise any bug reports or feature requests on the project's issue
28+
tracker. Be sure to search the list to see if your issue has already
29+
been raised.
30+
31+
### Creating new nodes
32+
33+
The plugin nature of Node-RED means anyone can create a new node to extend
34+
its capabilities. Eventually, the nodes will be npm-installable, but we're not
35+
there yet.
36+
37+
### Pull-Requests
38+
39+
In order for us to accept pull-requests, the contributor must first complete
40+
a Contributor License Agreement (CLA). This clarifies the intellectual
41+
property license granted with any contribution. It is for your protection as a
42+
Contributor as well as the protection of IBM and its customers; it does not
43+
change your rights to use your own Contributions for any other purpose.
44+
45+
## Authors
46+
47+
Node-RED is a creation of the IBM Emerging Technology Services team.
48+
49+
* Nick O'Leary [http://twitter.com/knolleary](@knolleary)
50+
* Dave Conway-Jones [http://twitter.com/ceejay](@ceejay)
51+
52+
## Copyright and license
53+
54+
Copyright 2013 IBM Corp. under [the Apache 2.0 license](LICENSE).

‎nodes/99-sample.html.demo‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
<!--
2+
Copyright 2013 IBM Corp.
3+
4+
Licensed under the Apache License, Version 2.0 (the "License");
5+
you may not use this file except in compliance with the License.
6+
You may obtain a copy of the License at
7+
8+
http://www.apache.org/licenses/LICENSE-2.0
9+
10+
Unless required by applicable law or agreed to in writing, software
11+
distributed under the License is distributed on an "AS IS" BASIS,
12+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
See the License for the specific language governing permissions and
14+
limitations under the License.
15+
-->
16+
17+
<!-- Sample html file that corresponds to the 99-sample.js file -->
18+
<!-- This creates and configures the onscreen elements of the node -->
19+
20+
<!-- First, the content of the edit dialog is defined. -->
21+
22+
<script type="text/x-red" data-template-name="sample">
23+
<!-- data-template-name identifies the node type this is for -->
24+
25+
<!-- Each of the following divs creates a field in the edit dialog. -->
26+
<!-- Generally, there should be an input for each property of the node. -->
27+
<!-- The for and id attributes identify the corresponding property -->
28+
<!-- (with the 'node-input-' prefix). -->
29+
<!-- The available icon classes are defined in Twitter Bootstrap -->
30+
<div class="form-row">
31+
<label for="node-input-topic"><i class="icon-tasks"></i> Topic</label>
32+
<input type="text" id="node-input-topic" placeholder="Topic">
33+
</div>
34+
35+
<!-- By convention, most nodes have a 'name' property. The following div -->
36+
<!-- provides the necessary field. -->
37+
<div class="form-row">
38+
<label for="node-input-name"><i class="icon-tag"></i> Name</label>
39+
<input type="text" id="node-input-name" placeholder="Name">
40+
</div>
41+
42+
</script>
43+
44+
45+
<!-- Next, some simple help text is provided for the node. -->
46+
<script type="text/x-red" data-help-name="sample">
47+
<!-- data-help-name identifies the node type this help is for -->
48+
<!-- This content appears in the Info sidebar when a node is selected -->
49+
<!-- The first <p> is used as the pop-up tool tip when hovering over a -->
50+
<!-- node in the palette. -->
51+
<p>Simple sample input node. Just sends a single message when it starts up.
52+
This is not very useful.</p>
53+
<p>Outputs an object called <b>msg</b> containing <b>msg.topic</b> and
54+
<b>msg.payload</b>. msg.payload is a String.</p>
55+
</script>
56+
57+
<!-- Finally, the node type is registered along with all of its properties -->
58+
<!-- The example below shows a small subset of the properties that can be set-->
59+
<script type="text/javascript">
60+
RED.nodes.registerType('sample',{
61+
category: 'input', // the palette category
62+
defaults: { // defines the editable properties of the node
63+
name: {value:""}, // along with default values.
64+
topic: {value:"", required:true}
65+
},
66+
inputs:0, // set the number of inputs - only 0 or 1
67+
outputs:1, // set the number of outputs - 0 to n
68+
icon: "arrow-in.png", // set the icon (held in public/icons)
69+
label: function() { // sets the default label contents
70+
return this.name||this.topic||"sample";
71+
},
72+
labelStyle: function() { // sets the class to apply to the label
73+
return this.name?"node_label_italic":"";
74+
}
75+
});
76+
</script>

0 commit comments

Comments
 (0)