pull-opc

pull-opc

pull streams for Open Pixel Control

npm install --save pull-opc

usage

createStream = require('pull-opc')

creates a stream that emits Open Pixel Control protocol messages.

stream = createStream()

this module is not effective for real-time pixels, since it buffers each message.

however it can be useful as a way to send special OPC messages before a stream of encoded pixels (hint: pull-cat)

stream.pushPixels(channel, pixels)

emits a set pixel colors command message with the color data in the pixels buffer.

stream.pushColorCorrection(config)

emits a Fadecandy set global color correction command message with the given config object.

stream.pushMessage(channel, command, data)

emits a generic Open Pixel Control message. Data should be a buffer.

createPixelsEncoder = require('pull-opc/encoder')

pixelsEncoder = createPixelsEncoder(channel)

pixelsEncoder is a through stream that receives opc/strand buffers and encodes them to Open Pixel Control messages.

createDecoder = require('pull-opc/decoder')

decoder = createDecoder()

create a through stream that parses binary data written to it an emits Open Pixel Control messages. message objects have the following properties:

• channel: The channel id
• command: The command id
• data: A buffer containing the message data

see also

• parshap/js-opc
• livejs/pixels-opc

license

The Apache License

Copyright © 2017 Michael Williams

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.