go-ncd-relay

A Go driver for the professional relay boards from National Control Devices.

Copyright (c) 2018, Andrew C. Young

Released under the MIT license

Example usage:

package main

import (
	"context"
	"log"
	"time"

	"github.com/jacobsa/go-serial/serial"
	"github.com/vaelen/go-ncd-relay/relay"
)

func main() {

	serialOptions := serial.OpenOptions{
		PortName:        "/dev/ttyUSB0",
		BaudRate:        115200,
		DataBits:        8,
		StopBits:        1,
		MinimumReadSize: 4,
	}

	// Open the serial port (using go-serial)
	port, err := serial.Open(serialOptions)
	if err != nil {
		log.Fatalf("Couldn't open serial port: %v", err)
	}
	defer port.Close()

	// Create the controller
	controller := relay.New(port)

	ctx, cancel := context.WithTimeout(context.Background(), time.Second*5)
	defer cancel()

	// Turn on a relay
	err = controller.TurnOnRelay(ctx, 1)
	if err != nil {
		log.Fatalf("Couldn't turn on relay: %v", err)
	}

	// Get the current status of the relay
	relayStatus, err := controller.GetRelayStatus(ctx, 1)
	if err != nil {
		log.Fatalf("Couldn't get relay status: %v", err)
	}
	log.Printf("Relay status: %t\n", relayStatus)

	// Turn off the relay
	err = controller.TurnOffRelay(ctx, 1)
	if err != nil {
		log.Fatalf("Couldn't turn off relay: %v", err)
	}

	// Get the current status of the relay
	relayStatus, err = controller.GetRelayStatus(ctx, 1)
	if err != nil {
		log.Fatalf("Couldn't get relay status: %v", err)
	}
	log.Printf("Relay status: %t\n", relayStatus)

	// Turn off the relay
	err = controller.TurnOffRelay(ctx, 1)
	if err != nil {
		log.Fatalf("Couldn't turn off relay: %v", err)
	}

	// Turn on an entire bank
	err = controller.SetBankStatus(ctx, 1, 0xFF)
	if err != nil {
		log.Fatalf("Couldn't set bank status: %v", err)
	}

	// Get the current status of the bank
	bankStatus, err := controller.GetBankStatus(ctx, 1)
	if err != nil {
		log.Fatalf("Couldn't get bank status: %v", err)
	}
	log.Printf("Bank status: %08b\n", bankStatus)

	// Turn off an entire bank
	err = controller.SetBankStatus(ctx, 1, 0x00)
	if err != nil {
		log.Fatalf("Couldn't set bank status: %v", err)
	}

	// Get the current status of the bank
	bankStatus, err = controller.GetBankStatus(ctx, 1)
	if err != nil {
		log.Fatalf("Couldn't get bank status: %v", err)
	}
	log.Printf("Bank status: %08b\n", bankStatus)

	// Read 1 AD in 8bit mode
	ad8, err := controller.ReadAD8(ctx, 1)
	if err != nil {
		log.Fatalf("Couldn't read AD in 8bit mode: %v", err)
	}
	log.Printf("AD 8bit value: %d\n", ad8)

	// Read all ADs in 8bit mode
	allAD8, err := controller.ReadAllAD8(ctx)
	if err != nil {
		log.Fatalf("Couldn't read all ADs in 8bit mode: %v", err)
	}
	log.Printf("All ADs 8bit values: %v\n", allAD8)

	// Read 1 AD in 10bit mode
	ad10, err := controller.ReadAD10(ctx, 1)
	if err != nil {
		log.Fatalf("Couldn't read AD in 10bit mode: %v", err)
	}
	log.Printf("AD 10bit value: %d\n", ad10)

	// Read all ADs in 10bit mode
	allAD10, err := controller.ReadAllAD10(ctx)
	if err != nil {
		log.Fatalf("Couldn't read all ADs in 10bit mode: %v", err)
	}
	log.Printf("All ADs 10bit values: %v\n", allAD10)
}