Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cleaning up code #138

Merged
merged 6 commits into from
Feb 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -6,35 +6,26 @@
import io.micronaut.http.annotation.Get;
import jakarta.inject.Named;


@Controller("/led")
public class LEDController {
private final LEDHelper ledHelper;


public LEDController(@Named("Led")DigitalOutput led){
public LEDController(@Named("led")DigitalOutput led){
this.ledHelper = new LEDHelper(led);
}

@Get("/LedOn")
@Get("/ledOn")
public void ledOn(){
/*deviceOff method turns on the LED after checking the output. This
will turn on the LED
*/

ledHelper.deviceOff();
ledHelper.ledOn();
}

@Get("/LedOff")
@Get("/ledOff")
public void ledOff(){

ledHelper.deviceOn();
ledHelper.ledOff();
}

@Get("/switchState")
public void switchState(){


ledHelper.switchState();
}
}
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
package com.opensourcewithslu.components.controllers;

import com.opensourcewithslu.inputdevices.PushButtonHelper;
import com.opensourcewithslu.inputdevices.RotaryEncoderHelper;
import com.opensourcewithslu.outputdevices.LEDHelper;
import com.pi4j.io.gpio.digital.DigitalInput;
import com.pi4j.io.gpio.digital.DigitalOutput;
Expand All @@ -15,11 +14,14 @@
@Controller("/multi")
public class MultiCompController {
private static final Logger log = LoggerFactory.getLogger(MultiCompController.class);
private LEDHelper ledHelper;

private LEDHelper ledHelper2;
private PushButtonHelper button1;
private PushButtonHelper button2;
private final LEDHelper ledHelper;

private final LEDHelper ledHelper2;

private final PushButtonHelper button1;

private final PushButtonHelper button2;

public MultiCompController(@Named("led") DigitalOutput led1,
@Named("led2") DigitalOutput led2,
Expand All @@ -41,7 +43,7 @@ public void switch2(){
ledHelper2.switchState();
}

@Get("/but1")
@Get("/button1")
public void button1(){
button1.addEventListener(e ->{
log.info(String.valueOf(button1.isPressed));
Expand All @@ -51,7 +53,7 @@ public void button1(){
});
}

@Get("/but2")
@Get("/button2")
public void button2(){
button2.addEventListener(e ->{
if(button2.isPressed){
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,15 @@
//tag::ex[]
@Controller("/pushButton")
public class PushButtonController {

private final PushButtonHelper pushButtonHelper;

private final LEDHelper ledHelper;

public PushButtonController(@Named("button-input-3") DigitalInput pushButton1,
@Named("led") DigitalOutput led1) {
this.pushButtonHelper = new PushButtonHelper(pushButton1);
this.ledHelper = new LEDHelper(led1);
public PushButtonController(@Named("button-input-3") DigitalInput pushButton,
@Named("led") DigitalOutput led) {
this.pushButtonHelper = new PushButtonHelper(pushButton);
this.ledHelper = new LEDHelper(led);
}

@Get("/init")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@
//tag::ex[]
@Controller("/rfid")
public class RfidController {

private final RFidHelper rfidHelper;

public RfidController(@Named("rfid") SpiConfig spi, Context pi4jContext){
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,10 @@
//tag::ex[]
@Controller("/rotaryEncoder")
public class RotaryEncoderController {

private final RotaryEncoderHelper encoderHelper;
private final RotaryEncoderHelper encoderHelper2;

public RotaryEncoderController(@Named("rotary-encoder")MultipinConfiguration rotaryEncoder, @Named("rotary-encoder-2")MultipinConfiguration rotaryEncoder2){
public RotaryEncoderController(@Named("rotary-encoder")MultipinConfiguration rotaryEncoder){
this.encoderHelper = new RotaryEncoderHelper(rotaryEncoder);
this.encoderHelper2 = new RotaryEncoderHelper(rotaryEncoder2);
}

@Get("/value")
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
package com.opensourcewithslu.components.controllers;

import com.opensourcewithslu.inputdevices.PushButtonHelper;
import com.opensourcewithslu.inputdevices.SlideSwitchHelper;
import com.opensourcewithslu.outputdevices.LEDHelper;
import com.pi4j.io.gpio.digital.DigitalInput;
import io.micronaut.http.annotation.Controller;
import io.micronaut.http.annotation.Get;
Expand Down Expand Up @@ -30,6 +28,5 @@ public boolean checkSwitch1(){
public boolean checkSwitch2(){
return slideSwitchHelper2.isOn;
}

}
//end::ex[]
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
import com.pi4j.io.i2c.I2CConfig;
import io.micronaut.http.annotation.Controller;
import io.micronaut.http.annotation.Get;
import io.micronaut.http.annotation.Post;
import jakarta.inject.Named;

//tag::ex[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,14 @@

import com.opensourcewithslu.outputdevices.RGBLEDHelper;
import com.opensourcewithslu.utilities.MultipinConfiguration;
import com.pi4j.io.pwm.Pwm;
import io.micronaut.http.annotation.Controller;
import io.micronaut.http.annotation.Get;
import jakarta.inject.Named;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

//tag::ex[]
@Controller("/rgb")
public class rgbController {
private final RGBLEDHelper rgbledHelper;
private static final Logger log = LoggerFactory.getLogger(rgbController.class);

public rgbController(@Named("rgb-led") MultipinConfiguration rgbLed){
this.rgbledHelper = new RGBLEDHelper(rgbLed);
Expand Down
Original file line number Diff line number Diff line change
@@ -1,17 +1,15 @@
package com.opensourcewithslu.inputdevices;

import com.pi4j.io.gpio.digital.DigitalInput;
import com.pi4j.io.gpio.digital.DigitalStateChangeListener;
import io.micronaut.context.annotation.Prototype;
import jakarta.annotation.PostConstruct;
import jakarta.inject.Named;
import jakarta.inject.Singleton;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class PushButtonHelper {
private static final Logger log = LoggerFactory.getLogger(PushButtonHelper.class);

private DigitalInput buttonInput;
private final DigitalInput buttonInput;

public Boolean isPressed;

//tag::const[]
Expand All @@ -28,11 +26,11 @@ public PushButtonHelper(DigitalInput buttonInput)
public void initialize()
//end::method[]
{
log.trace("Initializing " + buttonInput.getName());
log.info("Initializing " + buttonInput.getName());

buttonInput.addListener(e->{
isPressed = buttonInput.isHigh();
});
buttonInput.addListener(e->
isPressed = buttonInput.isHigh()
);
}

//tag::method[]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,18 +1,17 @@
package com.opensourcewithslu.inputdevices;

import com.pi4j.crowpi.components.exceptions.RfidException;
import com.pi4j.context.Context;
import com.pi4j.io.spi.SpiConfig;
import io.micronaut.context.annotation.Prototype;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.pi4j.crowpi.components.RfidComponent;

import java.util.concurrent.atomic.AtomicReference;


public class RFidHelper {
private static final Logger log = LoggerFactory.getLogger(RFidHelper.class);
private RfidComponent scanner;

private final RfidComponent scanner;

//tag::const[]
public RFidHelper(SpiConfig config, int reset, Context pi4jContext)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,24 +1,21 @@
package com.opensourcewithslu.inputdevices;
import com.opensourcewithslu.utilities.MultiPinConfigs.DigitalInputMultiPinConfiguration;

import com.opensourcewithslu.utilities.MultipinConfiguration;
import com.opensourcewithslu.utilities.Pi4JMultipinFactory;
import com.pi4j.io.gpio.digital.DigitalInput;
import com.pi4j.io.gpio.digital.DigitalListener;
import com.pi4j.io.gpio.digital.DigitalStateChangeListener;
import io.micronaut.context.annotation.Context;
import io.micronaut.context.annotation.Prototype;
import jakarta.annotation.PostConstruct;
import jakarta.inject.Named;
import jakarta.inject.Singleton;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class RotaryEncoderHelper {
private static final Logger log = LoggerFactory.getLogger(RotaryEncoderHelper.class);
private DigitalInput clk;
private DigitalInput dt;
private DigitalInput sw;
private String helperName;

private final DigitalInput clk;

private final DigitalInput dt;

private final DigitalInput sw;

private final String helperName;

private int globalCounter;

//tag::const[]
Expand All @@ -38,7 +35,7 @@ public RotaryEncoderHelper(MultipinConfiguration multiPin)
public void initialize()
//end::method[]
{
log.trace("Initializing " + helperName);
log.info("Initializing " + helperName);

String logInfo = helperName + " counter is {}";

Expand All @@ -59,7 +56,7 @@ else if (!clk.equals(dt.state())){
globalCounter--;
}
}
log.trace(logInfo, globalCounter);
log.info(logInfo, globalCounter);
});

sw.addListener(e -> {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,19 +1,14 @@
package com.opensourcewithslu.inputdevices;

import com.pi4j.io.gpio.digital.DigitalInput;
import com.pi4j.io.gpio.digital.DigitalStateChangeListener;
import io.micronaut.context.annotation.Prototype;
import jakarta.annotation.PostConstruct;
import jakarta.inject.Named;
import jakarta.inject.Singleton;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class SlideSwitchHelper {

private static final Logger log = LoggerFactory.getLogger(SlideSwitchHelper.class);

private DigitalInput slideSwitchInput;
private final DigitalInput slideSwitchInput;

public boolean isOn;

Expand All @@ -31,12 +26,11 @@ public SlideSwitchHelper(DigitalInput slideSwitchInput)
public void initialize()
//end::method[]
{
log.trace("Initializing Slide Switch");

slideSwitchInput.addListener(e->{
isOn = slideSwitchInput.isHigh();
});
log.info("Initializing Slide Switch");

slideSwitchInput.addListener(e->
isOn = slideSwitchInput.isHigh()
);
}

//tag::method[]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,10 @@
package com.opensourcewithslu.outputdevices;

import com.pi4j.Pi4J;
import com.pi4j.catalog.components.LcdDisplay;
import com.pi4j.context.Context;
import com.pi4j.io.i2c.I2CConfig;
import io.micronaut.context.annotation.Prototype;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.pi4j.crowpi.components.LcdDisplayComponent;

public class LCD1602Helper {
private static final Logger log = LoggerFactory.getLogger(LEDHelper.class);
Expand All @@ -20,22 +17,22 @@ public LCD1602Helper(I2CConfig i2CConfig, Context pi4jContext)
{
this.lcdDisplay = new LcdDisplay(pi4jContext, 4, 16);
lcdDisplay.setDisplayBacklight(true);
log.trace("LCD is set up with 4 rows and 16 columns. Backlight is on by default");
log.info("LCD is set up with 4 rows and 16 columns. Backlight is on by default");
}

//tag::method[]
public void writeText(String text)
//end::method[]
{
log.trace("writing");
log.info("writing");
lcdDisplay.displayText(text);
}

//tag::method[]
public void writeTextAtLine(String text, int line)
//end::method[]
{
log.trace("writing on " + line + "line");
log.info("writing on " + line + "line");
lcdDisplay.displayText(text, line);
}

Expand All @@ -46,10 +43,10 @@ public void setBackLight(boolean state)
log.info("changing backlight");

if (state){
log.trace("backlight on");
log.info("backlight on");
lcdDisplay.setDisplayBacklight(true);
} else{
log.trace("backlight off");
log.info("backlight off");
lcdDisplay.setDisplayBacklight(false);
}
}
Expand All @@ -58,7 +55,7 @@ public void setBackLight(boolean state)
public void clearDisplay()
//end::method[]
{
log.trace("Clear display");
log.info("Clear display");
lcdDisplay.clearDisplay();
}

Expand Down
Loading
Loading