Merge pull request #25 from jancumps/feature-set-2

Feature set 2 thank you @shabaz123

Author: jancumps

CMakeLists.txt

@@ -26,6 +26,9 @@ add_executable(pico_scpi_usbtmc_labtool
         ${CMAKE_CURRENT_SOURCE_DIR}/source/usb/usbtmc_app.c
         ${CMAKE_CURRENT_SOURCE_DIR}/source/scpi/scpi-def.c
         ${CMAKE_CURRENT_SOURCE_DIR}/source/gpio/gpio_utils.c
+        ${CMAKE_CURRENT_SOURCE_DIR}/source/adc/adc_utils.c
+        ${CMAKE_CURRENT_SOURCE_DIR}/source/adc16/adc16_utils.c
+        ${CMAKE_CURRENT_SOURCE_DIR}/source/pwm/pwm_utils.c
         $ENV{SCPI_LIB_PATH}/src/parser.c
         $ENV{SCPI_LIB_PATH}/src/lexer.c
         $ENV{SCPI_LIB_PATH}/src/error.c
@@ -34,17 +37,20 @@ add_executable(pico_scpi_usbtmc_labtool
         $ENV{SCPI_LIB_PATH}/src/utils.c
         $ENV{SCPI_LIB_PATH}/src/units.c
         $ENV{SCPI_LIB_PATH}/src/fifo.c
-        )
+        source/adc16/adc16_utils.c source/adc16/adc16_utils.h)
 
 target_include_directories(pico_scpi_usbtmc_labtool PRIVATE
         ${CMAKE_CURRENT_LIST_DIR}/source
         ${CMAKE_CURRENT_LIST_DIR}/source/usb
         ${CMAKE_CURRENT_LIST_DIR}/source/scpi
         ${CMAKE_CURRENT_LIST_DIR}/source/gpio
+        ${CMAKE_CURRENT_LIST_DIR}/source/adc
+        ${CMAKE_CURRENT_LIST_DIR}/source/adc16
+        ${CMAKE_CURRENT_LIST_DIR}/source/pwm
         $ENV{SCPI_LIB_PATH}/inc
 )
 
-target_link_libraries(pico_scpi_usbtmc_labtool PUBLIC pico_stdlib tinyusb_device tinyusb_board)
+target_link_libraries(pico_scpi_usbtmc_labtool PUBLIC pico_stdlib tinyusb_device tinyusb_board hardware_gpio hardware_adc hardware_pwm hardware_i2c)
 pico_add_extra_outputs(pico_scpi_usbtmc_labtool)
 
 # usb output, uart output

README.md

@@ -12,3 +12,4 @@ If you use VSCode: Preferences -> User -> Extensions -> CMake Tools -> CMake: Co
 PICO_SDK_PATH (e.g.: C:/Users/jancu/Documents/Pico/pico-sdk)  
 SCPI_LIB_PATH (e.g.: C:/Users/jancu/Documents/elektronica/scpi/scpi-parser/libscpi)
 
+[documentation](https://github.com/jancumps/pico_scpi_usbtmc_labtool/wiki) on GitHub wiki

source/adc/adc_utils.c

@@ -0,0 +1,35 @@
+#include "hardware/adc.h"
+
+#include "adc_utils.h"
+
+/*
+ADC0	GP26
+ADC1	GP27 // used for button on the pico-eurocard
+ADC2	GP28
+*/
+
+// supported pins
+uint adcPins[][2] = {
+    {0,26}, 
+    // {1,27}, // this is used for the button on the eurocard.
+    {2,28}
+};
+
+void initAdcUtils() {
+    adc_init();
+}
+
+uint32_t adcPinCount() {
+    return sizeof(adcPins)/(sizeof(adcPins[0][0])+sizeof(adcPins[0][1]));
+}
+
+void initAdcPins() {
+    for (uint32_t i = 0; i < adcPinCount(); i++) {
+        adc_gpio_init(adcPins[i][1]); // the gpio pin is needed here
+    }
+}
+
+uint16_t getAdcPinAt(uint32_t index) {
+      adc_select_input(adcPins[index][0]); // the ADC pin number is needed here
+      return adc_read();
+}

source/adc/adc_utils.h

@@ -0,0 +1,9 @@
+#ifndef _ADC_UTILS_H
+#define _ADC_UTILS_H
+
+void initAdcUtils();
+uint32_t adcPinCount();
+void initAdcPins();
+uint16_t getAdcPinAt(uint32_t index);
+
+#endif // _ADC_UTILS_H

source/adc16/adc16_utils.c

@@ -0,0 +1,137 @@
+#include "adc16_utils.h"
+#include "hardware/gpio.h"
+#include "hardware/i2c.h"
+
+
+/*
+ADC16 uses the I2C bus to communicate with the ASD1115 chip.
+The I2C bus is connected to the following pins:
+SCL: GP5
+SDA: GP4
+
+ ADC strategy:
+ The ADC is run in continuous-conversion mode. Currently only single-ended inputs are supported,
+ enumerated as channels 0-3. The ADC is configured to measure +2.048V full-scale, at a rate of 32 SPS,
+ i.e. a new result is available every 31.25ms. Note: when switching channels, the new result won't be
+ available for about 80 msec (2 * 31.25ms, plus a small margin).
+ In single-ended mode, the raw result is a 15-bit value, i.e. 0-32767.
+ To convert to a voltage, the reported raw result can be multiplied by 2.048/32767.
+*/
+
+/************** global vars ***************/
+uint8_t adc16Installed = 0;
+uint32_t adc16Channel = 0;
+uint8_t confreg[2]; // config register
+
+/************** functions *****************/
+// initialize the I2C bus
+void initAdc16I2C(void) {
+    i2c_init(i2c_default, 10000); // I2C0 on GPIO 4[SDA],5[SCL]
+    gpio_set_function(PICO_DEFAULT_I2C_SDA_PIN, GPIO_FUNC_I2C);
+    gpio_set_function(PICO_DEFAULT_I2C_SCL_PIN, GPIO_FUNC_I2C);
+    gpio_pull_up(PICO_DEFAULT_I2C_SDA_PIN); // weak pull-ups but enable them anyway
+    gpio_pull_up(PICO_DEFAULT_I2C_SCL_PIN);
+}
+
+// initialize the ADS1115 registers
+void initAdc16Reg(void) {
+    uint8_t buf[3];
+    // is the ADC chip installed?
+    buf[0] = ADS1115_REG_CONFIG;
+    i2c_write_blocking(i2c_default, ADS_ADDR, buf, 1, false);
+    i2c_read_blocking(i2c_default, ADS_ADDR, buf, 2, false);
+    if (buf[0] != 0x85 || buf[1] != 0x83) {
+        adc16Installed = 0; // no chip found
+        return;
+    } else {
+        adc16Installed = 1; // chip found
+    }
+    // set config register to desired values
+    confreg[0] = 0x44; // MUX set to AIN0, and PGA set to +-2.048V and continuous conversion mode
+    confreg[1] = 0x43; // rate = 32 SPS
+    buf[0] = ADS1115_REG_CONFIG;
+    buf[1] = confreg[0];
+    buf[2] = confreg[1];
+    i2c_write_blocking(i2c_default, ADS_ADDR, buf, 3, false);
+}
+
+// set the multiplexer to the desired input
+void setAdc16Mux(uint8_t mux) {
+    uint8_t buf[3];
+    confreg[0] &= ~0x70; // clear the MUX bits
+    confreg[0] |= (mux<<4); // set the MUX bits
+    buf[0] = ADS1115_REG_CONFIG;
+    buf[1] = confreg[0];
+    buf[2] = confreg[1];
+    i2c_write_blocking(i2c_default, ADS_ADDR, buf, 3, false);
+}
+
+// start a conversion (this is only for single-shot mode)
+// will delete this function if it's not needed
+void startAdc16Conv(void) {
+    uint8_t buf[3];
+    buf[0] = ADS1115_REG_CONFIG;
+    buf[1] = confreg[0] | 0x80; // set 'OS' bit to start a conversion
+    buf[2] = confreg[1];
+    i2c_write_blocking(i2c_default, ADS_ADDR, buf, 3, false);
+}
+
+// check if the conversion is complete (this may only work for single-shot mode)
+// will delete this function if it's not needed
+uint8_t adc16ConvDone(void) {
+    uint8_t buf[3];
+    buf[0] = ADS1115_REG_CONFIG;
+    i2c_write_blocking(i2c_default, ADS_ADDR, buf, 1, false);
+    i2c_read_blocking(i2c_default, ADS_ADDR, buf, 2, false);
+    if (buf[0] & 0x80) {
+        return 0; // conversion not done
+    } else {
+        return 1; // conversion done
+    }
+}
+
+// read the conversion register
+uint16_t readAdc16Meas(void) {
+    uint16_t meas;
+    uint16_t buf;
+    uint8_t* buf8_ptr = (uint8_t*)&buf;
+    *buf8_ptr = ADS1115_REG_CONVERSION;
+    i2c_write_blocking(i2c_default, ADS_ADDR, buf8_ptr, 1, false);
+    i2c_read_blocking(i2c_default, ADS_ADDR, buf8_ptr, 2, false);
+    meas = buf>>8 | buf<<8; // swap bytes
+    if (adc16Channel < 4) {
+        // we are in single-ended mode. Any integer value less than 0 is invalid
+        // and since we are dealing with unsigned values, that means that any
+        // value greater than 32767 is invalid.
+        if (meas > 32767) {
+            meas = 0;
+        }
+    }
+    return(meas);
+}
+
+// provide a pin count. returns 0 if the ADS1115 is not installed
+uint32_t adc16PinCount() {
+    if (adc16Installed) {
+        return(4);
+    } else {
+        return(0);
+    }
+}
+
+// get ADC result from the ADS1115
+uint16_t getAdc16PinAt(uint32_t index) {
+    uint16_t res;
+    if (adc16Channel == index) {
+        // already set to this channel
+    } else {
+        // switch channel, and then wait for a conversion to be done
+        adc16Channel = index;
+        setAdc16Mux(ADS1115_CH0 + index);
+        // no need to start conversion, since we are in continuous conversion mode
+        sleep_ms(80); // wait for conversion to complete. The value should be 2 * (1/SPS) + margin
+    }
+    res = readAdc16Meas();
+    // no need to start another conversion, since we are in continuous conversion mode
+    return(res);
+}

source/adc16/adc16_utils.h

@@ -0,0 +1,29 @@
+#ifndef _ADC16_UTILS_H
+#define _ADC16_UTILS_H
+
+/********** includes **********/
+#include "pico/stdlib.h"
+
+/******* defines *********************/
+// ADS1115 ADDR pin set to 0V results in I2C address 0x48
+#define ADS_ADDR 0x48
+// ADS1115 registers (4)
+#define ADS1115_REG_CONVERSION 0x00
+#define ADS1115_REG_CONFIG 0x01
+#define ADS1115_REG_LO_THRESH 0x02
+#define ADS1115_REG_HI_THRESH 0x03
+// ADS1115 mux values
+#define ADS1115_CH0 0x04
+#define ADS1115_CH1 0x05
+#define ADS1115_CH2 0x06
+#define ADS1115_CH3 0x07
+#define ADS1115_DIFF_0_1 0x00
+#define ADS1115_DIFF_2_3 0x11
+
+/******* functions *********/
+void initAdc16I2C(void);
+void initAdc16Reg(void);
+uint32_t adc16PinCount();
+uint16_t getAdc16PinAt(uint32_t index);
+
+#endif // _ADC16_UTILS_H

source/gpio/gpio_utils.c

@@ -4,29 +4,35 @@
 #include "gpio_utils.h"
 
 // supported pins
-uint pins[] = {
+uint outPins[] = {
     /*PICO_DEFAULT_LED_PIN, removed in this project, because the USBTMC code makes good use of it to show USB status
     if you want to use this pin, remove the led_blinking_task() */
     22, 14, 15};
 
+// TODO input pins
 
-uint32_t pinCount() {
-    return sizeof(pins)/sizeof(pins[0]);
+void initGpioUtils() {
+    return; // nothing needed
 }
 
-void initPins() {
-    for (uint32_t i = 0; i < pinCount(); i++) {
-        gpio_init(pins[i]);
-        gpio_set_dir(pins[i], 1);
-        gpio_put(pins[i], 0);
+uint32_t outPinCount() {
+    return sizeof(outPins)/sizeof(outPins[0]);
+}
+
+void initOutPins() {
+    for (uint32_t i = 0; i < outPinCount(); i++) {
+        gpio_init(outPins[i]);
+        gpio_set_dir(outPins[i], 1);
+        gpio_put(outPins[i], 0);
     }
 }
 
-void setPinAt(uint32_t index, bool on) {
-    gpio_put(pins[index], on);
+void setOutPinAt(uint32_t index, bool on) {
+    gpio_put(outPins[index], on);
 }
 
-bool isPinAt(uint32_t index) {
-    return gpio_get_out_level(pins[index]);
+bool isOutPinAt(uint32_t index) {
+    return gpio_get_out_level(outPins[index]);
 }
 
+// TODO input pins

source/gpio/gpio_utils.h

@@ -2,9 +2,12 @@
 #define _GPIO_UTILS_H
 
 
-uint32_t pinCount();
-void initPins();
-void setPinAt(uint32_t index, bool on);
-bool isPinAt(uint32_t index);
+uint32_t outPinCount();
+void initGpioUtils();
+void initOutPins();
+void setOutPinAt(uint32_t index, bool on);
+bool isOutPinAt(uint32_t index);
+
+// TODO gpio input pins
 
 #endif // _GPIO_UTILS_H

source/pwm/pwm_utils.c

@@ -0,0 +1,22 @@
+#include "hardware/pwm.h"
+
+#include "pwm_utils.h"
+
+void initPwmUtils() {
+    // TODO pwm_init();
+}
+
+uint32_t pwmPinCount() {
+    // TODO implement
+    return 0;
+}
+
+void initPwmPins() {
+    // TODO implement
+    return;
+}
+
+void setPwmPinAt(uint32_t index, uint32_t value)  {
+    // TODO implement
+    return;
+}

source/pwm/pwm_utils.h

@@ -0,0 +1,9 @@
+#ifndef _PWM_UTILS_H
+#define _PWM_UTILS_H
+
+void initPwmUtils();
+uint32_t pwmPinCount();
+void initPwmPins();
+void setPwmPinAt(uint32_t index, uint32_t value);
+
+#endif // _PWM_UTILS_H