eitch
/
ch.eitchnet.beaglebone
mirror of
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[Project] Updated README for new interface GpioBridge

This commit is contained in:
Robert von Burg 2017-03-06 10:09:53 +01:00
parent 16efd2a498
commit 2f6930848e
2 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -34,7 +34,7 @@ The `GpioBridge.getGpio()`-method will throw an exception if:
### Reading Input Pins
To read the current signal of a pin use the `GpioBridge.readValue()`-method:
<pre>
GpioBridge gpioBridge = GpioBridge.getInstance();
GpioBridge gpioBridge = GpioBridgeImpl.getInstance();
Gpio pin8_07 = gpioBridge.getGpio(Pin.P8_07, Direction.IN);
Signal currentSignal = gpioBridge.readValue(pin8_07);
System.out.println(pin8_07 + " currently has signal " + currentSignal);
@ -43,7 +43,7 @@ System.out.println(pin8_07 + " currently has signal " + currentSignal);
### Writing Output Pins
To write the signal of a pin use the `GpioBridge.writeValue()`-method:
<pre>
GpioBridge gpioBridge = GpioBridge.getInstance();
GpioBridge gpioBridge = GpioBridgeImpl.getInstance();
Gpio pin8_08 = gpioBridge.getGpio(Pin.P8_08, Direction.OUT);
gpioBridge.writeValue(pin8_08, Signal.HIGH);
System.out.println("Set signal of " + pin8_08 + " to " + Signal.HIGH);
@ -52,7 +52,7 @@ System.out.println("Set signal of " + pin8_08 + " to " + Signal.HIGH);
### Observing Input Pins
To be notified of changes to an input GPIO, register a `GpioSignalListener`:
<pre>
GpioBridge gpioBridge = GpioBridge.getInstance();
GpioBridge gpioBridge = GpioBridgeImpl.getInstance();
Gpio pin8_07 = gpioBridge.getGpio(Pin.P8_07, Direction.IN);
gpioBridge.register(pin8_07, gpio -> System.out.println("Signal of "+pin8_07 + " has changed to " + gpio.getSignal()));
</pre>

1
src/main/java/ch/eitchnet/beaglebone/GpioBridge.java
View File

@ -1,6 +1,7 @@
package ch.eitchnet.beaglebone;
public interface GpioBridge {
/**
* <p>
* Public API method to write the given {@link Signal} on the given {@link Gpio}'s pin.