ignoble-node.html

<script type="text/javascript">
	RED.nodes.registerType('scanner', {
		category: 'Bluetooth',
		color: '#a6bbcf',
		defaults: {
			name: {
				value: ""
			},
			timeout: {
				value: 5000,
				validate: function(v) {
					return v >= 5000;
				},
				required: true
			}
		},
		inputs: 1,
		outputs: 1,
		icon: "bluetooth.png",
		label: function() {
			return this.name || "scanner";
		}
	});
</script>

<script type="text/x-red" data-template-name="scanner">
    <div class="form-row">
        <label for="node-input-name"><i class="icon-tag"></i> Name</label>
        <input type="text" id="node-input-name" placeholder="Name">
    </div>
    <div class="form-row">
        <label for="node-input-timeout"><i class="icon-tag"></i> Scan time</label>
        <input type="text" id="node-input-timeout" placeholder="Time in milliseconds">
    </div>
</script>

<script type="text/x-red" data-help-name="scanner">
    <p>A node that performs a BLE scan for peripherals in the vicinity.  Hook up a trigger to it and set the scan time!</p>
</script>

<script type="text/javascript">
	RED.nodes.registerType('peripheral', {
		category: 'Bluetooth',
		color: '#a6bbcf',
		defaults: {
			name: {
				value: ""
			},
			mac: {
				value: "",
				required: true
			},
			timeout: {
				value: 10000,
				validate: function(v) {
					return v >= 0;
				},
				required: true
			}
		},
		inputs: 1,
		outputs: 2,
		icon: "bluetooth.png",
		label: function() {
			return this.name || "peripheral";
		}
	});
</script>

<script type="text/x-red" data-template-name="peripheral">
    <div class="form-row">
        <label for="node-input-name"><i class="icon-tag"></i> Name</label>
        <input type="text" id="node-input-name" placeholder="Name">
    </div>
    <div class="form-row">
        <label for="node-input-mac"><i class="icon-tag"></i> MAC Address</label>
        <input type="text" id="node-input-mac" placeholder="MAC Address">
    </div>
    <div class="form-row">
        <label for="node-input-timeout"><i class="icon-tag"></i> Timeout</label>
        <input type="text" id="node-input-timeout" placeholder="Timeout">
    </div>
</script>

<script type="text/x-red" data-help-name="peripheral">
    <p>A BLE node that matches a peripheral with a MAC address, performs a connection and interrogates it for services.</p>

    <h3>Inputs</h3>
        <dl class="message-properties">
            <dt>payload <span class="property-type">object</span>
            </dt>
            <dd> the output of a scanner node</dd>
        </dl>
    <h3>Outputs</h3>
        <ol class="node-ports">
	    <li>connected
                <dl class="message-properties">
		    <dt />
                    <dd> this port is called when services have been discovered</dd>
                </dl>
            </li>
            <li>disconnected
                <dl class="message-properties">
		    <dt />
                    <dd> this port is called when the peripheral has been disconnected</dd>
                </dl>
            </li>
        </ol>
    <h3>Details</h3>
	<p>Hook this up to a scanner!</p>
        <p>Set the timeout to 0 so that it will stay connected forever and you can subscribe to characteristic notification changes!</p>
	<p>Use the <code>disconnected</code> output port to re-trigger a scan in the case of an unwanted disconnection, or to connect to another peripheral!</p>
</script>

<script type="text/javascript">
	RED.nodes.registerType('service', {
		category: 'Bluetooth',
		color: '#a6bbcf',
		defaults: {
			name: {
				value: ""
			}
		},
		inputs: 1,
		outputs: 1,
		icon: "bluetooth.png",
		label: function() {
			return this.name || "service";
		}
	});
</script>

<script type="text/x-red" data-template-name="service">
    <div class="form-row">
        <label for="node-input-name"><i class="icon-tag"></i> Name</label>
        <input type="text" id="node-input-name" placeholder="Name">
    </div>
</script>

<script type="text/x-red" data-help-name="service">
    <p>A BLE node that shunts a peripheral's services to a characteristic node.  Hook this up to a peripheral!</p>
</script>

<script type="text/javascript">
	RED.nodes.registerType('characteristic', {
		category: 'Bluetooth',
		color: '#a6bbcf',
		defaults: {
			name: {
				value: ""
			},
			uuid: {
				value: "",
				required: true
			},
			subscribe: {
				value: false
			}
		},
		inputs: 1,
		outputs: 1,
		icon: "bluetooth.png",
		label: function() {
			return this.name || this.uuid || "characteristic";
		}
	});
</script>

<script type="text/x-red" data-template-name="characteristic">
    <div class="form-row">
        <label for="node-input-name"><i class="icon-tag"></i> Name</label>
        <input type="text" id="node-input-name" placeholder="Name">
    </div>
    <div class="form-row">
        <label for="node-input-uuid"><i class="icon-tag"></i> UUID</label>
        <input type="text" id="node-input-uuid" placeholder="UUID">
    </div>
    <div class="form-row">
        <label for="node-input-subscribe"><i class="icon-tag"></i> Subscribe</label>
        <input type="checkbox" id="node-input-subscribe" placeholder="Subscribe">
    </div>
</script>

<script type="text/x-red" data-help-name="characteristic">
    <p>A BLE node that matches a service's characteristic by UUID</p>

    <h3>Inputs</h3>
        <dl class="message-properties">
            <dt>payload <span class="property-type">object</span>
            </dt>
            <dd> the output of a service node</dd>
        </dl>
    <h3>Outputs</h3>
        <ol class="node-ports">
	    <li>
                <dl class="message-properties">
		    <dt />
                    <dd> this port is called when the characteristic has been read</dd>
                </dl>
            </li>
        </ol>
    <h3>Details</h3>
	<p>Hook this up to a service!</p>
	<p>If the characteristic is notifiable then <code>subscribe</code> to it and don't forget to set the peripheral timeout to 0.</p>
	<p>Use the output port to daisy chain <code>characteristic</code> nodes so they can be read sequentially.</p>
</script>

<script type="text/javascript">
	RED.nodes.registerType('characteristic out', {
		category: 'Bluetooth',
		color: '#a6bbcf',
		defaults: {
			name: {
				value: ""
			},
			uuid: {
				value: "",
				required: true
			}
		},
		align: 'right',
		inputs: 1,
		outputs: 0,
		icon: "bluetooth.png",
		label: function() {
			return this.name || this.uuid || "characteristic";
		}
	});
</script>

<script type="text/x-red" data-template-name="characteristic out">
    <div class="form-row">
        <label for="node-input-name"><i class="icon-tag"></i> Name</label>
        <input type="text" id="node-input-name" placeholder="Name">
    </div>
    <div class="form-row">
        <label for="node-input-uuid"><i class="icon-tag"></i> UUID</label>
        <input type="text" id="node-input-uuid" placeholder="UUID">
    </div>
</script>

<script type="text/x-red" data-help-name="characteristic out">
    <p>A BLE node that matches a service's characteristic by UUID.  Hook this up to a service! You can use this node to write msg.payload to the characteristic!  Make sure that the characteristic on your BLE peripheral has enough room for the data contained in msg.payload!</p>
</script>