♻️ Alias adaptor factor in hal namespace (#44)

Author: Khalil Estell

.github/workflows/ci.yml

@@ -17,9 +17,9 @@ name: ✅ CI
 on:
   workflow_dispatch:
   pull_request:
+  release:
+    types: [published]
   push:
-    tags:
-      - "*"
     branches:
       - main
   schedule:
@@ -36,14 +36,3 @@ jobs:
   devices:
     uses: libhal/ci/.github/workflows/deploy.yml@4.1.0
     secrets: inherit
-
-  release:
-    needs: [ci, devices]
-    if: startsWith(github.ref, 'refs/tags/')
-    runs-on: ubuntu-22.04
-    steps:
-      - name: Release
-        uses: softprops/action-gh-release@v1
-        if: startsWith(github.ref, 'refs/tags/')
-        with:
-          generate_release_notes: true

include/libhal-soft/adc_mux.hpp

@@ -21,24 +21,6 @@
 #include <libhal/output_pin.hpp>
 #include <libhal/steady_clock.hpp>
 
-namespace hal::soft {
-class adc_multiplexer;
-class adc_mux_pin;
-}  // namespace hal::soft
-
-namespace hal::make {
-/**
- * @brief Returns an ADC pin from the multiplexer.
- *
- * @param p_multiplexer the adc multiplexer with the desire adc channel pin
- * @param p_channel The channel number of the pin
- * @return A newly constructed ADC multiplexer pin.
- * @throws std::errc::
- */
-result<hal::soft::adc_mux_pin> adc(hal::soft::adc_multiplexer& p_multiplexer,
-                                   std::uint8_t p_channel);
-}  // namespace hal::make
-
 namespace hal::soft {
 /**
  * @brief A driver for an ADC multiplexer that manages and reads ADC mux pins.
@@ -75,7 +57,7 @@ class adc_multiplexer
 
   /**
    * @brief Gets the highest capacity channel held by the ADC mux object.
-   * This is caluclated based off of how many source pins are available.
+   * This is calculated based off of how many source pins are available.
    *
    * @return The maximum channel number for this mux (2^n states, where n is
    * number of source pins).
@@ -98,9 +80,8 @@ class adc_multiplexer
  */
 class adc_mux_pin : public hal::adc
 {
-  friend hal::result<adc_mux_pin>(
-    ::hal::make::adc(hal::soft::adc_multiplexer& p_multiplexer,
-                     std::uint8_t p_channel));
+  friend hal::result<adc_mux_pin> make_adc(adc_multiplexer& p_multiplexer,
+                                           std::uint8_t p_channel);
 
 private:
   adc_mux_pin(adc_multiplexer& p_mux, std::uint8_t p_mux_port);
@@ -109,4 +90,20 @@ class adc_mux_pin : public hal::adc
   adc_multiplexer* m_mux;
   std::uint8_t m_mux_port;
 };
+
+/**
+ * @brief Returns an ADC pin from the multiplexer.
+ *
+ * @param p_multiplexer the adc multiplexer with the desire adc channel pin
+ * @param p_channel The channel number of the pin
+ * @return A newly constructed ADC multiplexer pin.
+ * @throws std::errc::result_out_of_range if p_channel greater than the
+ * available number of channels in the multiplexer.
+ */
+result<adc_mux_pin> make_adc(adc_multiplexer& p_multiplexer,
+                             std::uint8_t p_channel);
 }  // namespace hal::soft
+
+namespace hal {
+using hal::soft::make_adc;
+}  // namespace hal

src/adc_mux.cpp

@@ -68,15 +68,13 @@ hal::result<hal::adc::read_t> adc_mux_pin::driver_read()
 {
   return m_mux->read_channel(m_mux_port);
 }
-}  // namespace hal::soft
 
-namespace hal::make {
-result<hal::soft::adc_mux_pin> adc(hal::soft::adc_multiplexer& p_multiplexer,
-                                   std::uint8_t p_channel)
+result<adc_mux_pin> make_adc(adc_multiplexer& p_multiplexer,
+                             std::uint8_t p_channel)
 {
   if (p_channel > p_multiplexer.get_max_channel()) {
     return hal::new_error(std::errc::result_out_of_range);
   }
-  return hal::soft::adc_mux_pin(p_multiplexer, p_channel);
+  return adc_mux_pin(p_multiplexer, p_channel);
 }
-}  // namespace hal::make
+}  // namespace hal::soft

tests/adc_mux.test.cpp

@@ -73,7 +73,7 @@ void adc_mux_test()
     // Setup
     adc_multiplexer test_mux =
       adc_multiplexer::create(signal_pins, source_adc, mock_timer);
-    adc_mux_pin test_adc_port_zero = hal::make::adc(test_mux, 0).value();
+    adc_mux_pin test_adc_port_zero = hal::make_adc(test_mux, 0).value();
     constexpr float expected_sample_zero = 0;
 
     // Exercise
@@ -88,8 +88,8 @@ void adc_mux_test()
     // Setup
     adc_multiplexer test_mux =
       adc_multiplexer::create(signal_pins, source_adc, mock_timer);
-    adc_mux_pin first_mux_pin = hal::make::adc(test_mux, 1).value();
-    adc_mux_pin second_mux_pin = hal::make::adc(test_mux, 2).value();
+    adc_mux_pin first_mux_pin = hal::make_adc(test_mux, 1).value();
+    adc_mux_pin second_mux_pin = hal::make_adc(test_mux, 2).value();
     constexpr float expected_sample_zero = 0;
     constexpr float expected_sample_three_halves = 1.5;
 
@@ -123,12 +123,12 @@ void adc_mux_test()
 
     // Exercise
     auto test_read_data = std::array<hal::result<hal::adc::read_t>, 4>{
-      hal::make::adc(test_mux, 0).value().read(),
-      hal::make::adc(test_mux, 1).value().read(),
-      hal::make::adc(test_mux, 2).value().read(),
-      hal::make::adc(test_mux, 3).value().read()
+      hal::make_adc(test_mux, 0).value().read(),
+      hal::make_adc(test_mux, 1).value().read(),
+      hal::make_adc(test_mux, 2).value().read(),
+      hal::make_adc(test_mux, 3).value().read()
     };
-    auto error_test = hal::make::adc(test_mux, 4).value().read();
+    auto error_test = hal::make_adc(test_mux, 4).value().read();
 
     // Verify
     for (auto& p : test_read_data) {