OpcServer

KO | EN

gitlite — search

#hacktoberfest #react #ai #golang #android #machine-learning #rust #deep-learning #windows #awesome #vue #ios #mcp #openai

(★ 14)

Open Pixel Control (OPC) server for Arduino

OpcServer Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# OpcServer

[![Build Status](https://travis-ci.org/plasticrake/OpcServer.svg?branch=master)](https://travis-ci.org/plasticrake/OpcServer)

Open Pixel Control (OPC) server for Arduino.

Compatible with boards that utilize Arduino style [WiFiServer](https://www.arduino.cc/en/Reference/WiFiServer) / [WiFiClient](https://www.arduino.cc/en/Reference/WiFiClient) APIs.

- **ESP8266**
  - NodeMCU
  - [Adafruit HUZZAH](https://www.adafruit.com/products/2471)
  - ...
- **ATSAMD21**
  - [Arduino Zero](https://www.arduino.cc/en/Main/ArduinoBoardZero) with [WiFi Shield 101](https://www.arduino.cc/en/Main/ArduinoWiFiShield101) **(compiles, not tested)**
  - [Adafruit Feather M0 WiFi - ATSAMD21 + ATWINC1500](https://www.adafruit.com/product/3010) **(compiles, not tested)**
- **Particle** (Formerly Spark)
  - [Photon](https://docs.particle.io/datasheets/photon-datasheet/)
  - [Core](https://docs.particle.io/datasheets/core-datasheet/) **(compiles, not tested)**

If you've run this successfully on other boards let me know!

# Installation

## Arduino IDE
1. In the Arduino IDE, Choose **Sketch** > **Include Library** > **Manage Libraries**
2. Search for **OpcServer**
3. Click **Install**

## [PlatformIO](http://platformio.org/lib/show/350/OpcServer)
1. platformio lib install 350

## Particle
1. Copy files from src/* into your project

# Usage
See [examples](https://github.com/plasticrake/OpcServer/tree/master/examples).
### Includes
```c++
#include "OpcServer.h"
```
Depending on your platform you may need to add other headers. For example _ESP8266WiFi.h_ for ESP8266.

### Initialize
Initialize `OpcServer` with `WiFiServer` (or `TCPServer` for Particle), `OpcClient` sized for the number of clients you'd like to support, and a `buffer` large enough for the OPC messages you'd like to receive.
```c++
WiFiServer server = WiFiServer(OPC_PORT);
OpcClient opcClients[OPC_MAX_CLIENTS];
uint8_t buffer[OPC_BUFFER_SIZE * OPC_MAX_CLIENTS];

OpcServer opcServer = OpcServer(server, OPC_CHANNEL,
  opcClients, OPC_MAX_CLIENTS,
  buffer, OPC_BUFFER_SIZE);
```

### setup()

Optionally add any callback functions you'd like `OpcServer` to run when a message is received or a client connects/disconnects.
```c++
opcServer.setMsgReceivedCallback(cbOpcMessage);
opcServer.setClientConnectedCallback(cbOpcClientConnected);
opcServer.setClientDisconnectedCallback(cbOpcClientDisconnected);
```
Then call `.begin()`.
```c++
opcServer.begin();
```

### loop()
Call `.process()` in your loop to process any incoming OPC data.
```c++
opcServer.process();
```

OpcServer

OpcServer Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

OpcServer

OpcServer Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README