DigitalInputExample.java

/*
 * The MIT License.
 *
 * Copyright (c) 2022 Peter Froud.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package xyz.froud.jmccul_examples;

import xyz.froud.jmccul.DaqDevice;
import xyz.froud.jmccul.JMCCULException;
import xyz.froud.jmccul.digital.DigitalPort;
import xyz.froud.jmccul.digital.DigitalPortDirection;

import java.util.Optional;

/**
 * @author Peter Froud
 */
public class DigitalInputExample {

    public static void main(String[] args) throws JMCCULException {

        final Optional<DigitalPort> optionalPort = DaqDevice.findPortMatching(DigitalPort::isInputSupported);

        if (optionalPort.isPresent()) {
            final DigitalPort port = optionalPort.get();
            try ( DaqDevice device = port.getDaqDevice()) {
                System.out.printf("Using device with model name %s, serial number %s, port %s.\n",
                        device.getBoardName(), device.getFactorySerialNumber(), port.getPortType());

                doDigitalInput(device, port);
            }

        } else {
            System.out.println("Didn't find a device which supports digital input.");
        }

    }

    private static void doDigitalInput(DaqDevice device, DigitalPort port) throws JMCCULException {

        if (port.isDirectionOfEntirePortSettable()) {
            port.setPortDirection(DigitalPortDirection.INPUT);
        }

        System.out.println("Reading the whole port:");
        final short portInput = device.digital.input.readPort(port.getPortType());
        System.out.println("0b" + Integer.toBinaryString(portInput));

        final int portInput32 = device.digital.input.readPort32(port.getPortType());

        System.out.println("Now reading one bit at a time:");
        System.out.print("0b");
        for (int bitIndex = port.getResolution() - 1; bitIndex >= 0; bitIndex--) {
            port.setBitDirection(bitIndex, DigitalPortDirection.INPUT);
            final boolean bitInput = device.digital.input.readBit(port.getPortType(), bitIndex);
            final char zeroOrOne = bitInput ? '1' : '0';
            System.out.print(zeroOrOne);
        }
        System.out.println();

    }

}