chore: upgrade to embedded-hal v1.0.0 (#2)

* chore: upgrade to embedded-hal v1.0.0

* ci: upgrade actions

- upgrade checkout action
- use maintained rust toolchain
- remove old rust verion from matrix
- run cargo directly
- switch coverage action to llvm-cov

* Update CHANGELOG.md

---------

Co-authored-by: Diego Barrios Romero <[email protected]>

Author: sanzoghenzo

.github/workflows/build.yml

@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        rust: [stable, 1.31.0]
+        rust: [stable]
         TARGET:
           - x86_64-unknown-linux-gnu
           - x86_64-unknown-linux-musl
@@ -26,16 +26,14 @@ jobs:
           - thumbv7m-none-eabi
 
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions-rs/toolchain@v1
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@master
         with:
-          profile: minimal
           toolchain: ${{ matrix.rust }}
           target: ${{ matrix.TARGET }}
-          override: true
 
       - name: Checkout CI scripts
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
         with:
           repository: 'eldruin/rust-driver-ci-scripts'
           ref: 'master'
@@ -45,10 +43,7 @@ jobs:
         if: ${{ ! contains(matrix.TARGET, 'x86_64') }}
 
       - name: Build
-        uses: actions-rs/cargo@v1
-        with:
-          command: build
-          args: --target=${{ matrix.TARGET }}
+        run: cargo build --target=${{ matrix.TARGET }}
 
   checks:
     name: Checks
@@ -60,89 +55,72 @@ jobs:
           - x86_64-unknown-linux-gnu
 
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions-rs/toolchain@v1
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@master
         with:
-          profile: minimal
           toolchain: ${{ matrix.rust }}
           target: ${{ matrix.TARGET }}
-          override: true
           components: rustfmt
 
       - name: Doc
-        uses: actions-rs/cargo@v1
-        with:
-          command: doc
+        run: cargo doc
 
       - name: Formatting
-        uses: actions-rs/cargo@v1
-        with:
-          command: fmt
-          args: --all -- --check
+        run: cargo fmt --all -- --check
 
   clippy:
     name: Clippy
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        rust: [1.54.0]
+        rust: [stable]
         TARGET:
           - x86_64-unknown-linux-gnu
 
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions-rs/toolchain@v1
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@master
         with:
-          profile: minimal
           toolchain: ${{ matrix.rust }}
           target: ${{ matrix.TARGET }}
-          override: true
           components: clippy
 
-      - name: Clippy
-        uses: actions-rs/clippy-check@v1
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
+      - run: cargo clippy --message-format=json --all-features
 
   test:
     name: Tests
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        rust: [stable, beta]
+        rust: [stable]
         TARGET: [x86_64-unknown-linux-gnu, x86_64-unknown-linux-musl]
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions-rs/toolchain@v1
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@master
         with:
-          profile: minimal
           toolchain: ${{ matrix.rust }}
           target: ${{ matrix.TARGET }}
-          override: true
 
       - name: Test
-        uses: actions-rs/cargo@v1
-        with:
-          command: test
-          args: --target=${{ matrix.TARGET }}
+        run: cargo test --target=${{ matrix.TARGET }}
 
   coverage:
     name: Coverage
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Install stable toolchain
-        uses: actions-rs/toolchain@v1
+        uses: dtolnay/rust-toolchain@master
         with:
           toolchain: stable
-          override: true
 
-      - name: Run cargo-tarpaulin
-        uses: actions-rs/[email protected]
-        with:
-          args: '--out Lcov -- --test-threads 1'
+      - name: Install cargo-llvm-cov
+        uses: taiki-e/install-action@cargo-llvm-cov
+
+      - name: Generate code coverage
+        run: cargo llvm-cov --all-features --workspace --lcov --output-path lcov.info
 
       - name: upload to Coveralls
         uses: coverallsapp/github-action@master

CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Changed
 - Updated dependencies
+- [breaking-change] upgrade project to support embedded-hal v1.0.0
 
 ## [0.2.0] - 2020-09-10
 
@@ -23,4 +24,4 @@ Initial release to crates.io.
 
 [Unreleased]: https://github.com/eldruin/embedded-ccs811-rs/compare/v0.2.0...HEAD
 [0.2.0]: https://github.com/eldruin/embedded-ccs811-rs/compare/v0.1.0...v0.2.0
-[0.1.0]: https://github.com/eldruin/embedded-ccs811-rs/releases/tag/v0.1.0
+[0.1.0]: https://github.com/eldruin/embedded-ccs811-rs/releases/tag/v0.1.0

Cargo.toml

@@ -21,12 +21,12 @@ include = [
 edition = "2018"
 
 [dependencies]
-embedded-hal = "0.2.6"
+embedded-hal = "1.0.0"
 nb = "1"
 
 [dev-dependencies]
-linux-embedded-hal = "0.3"
-embedded-hal-mock = "0.8"
+embedded-hal-mock = { version = "0.11.1", features = ["eh1"] }
+linux-embedded-hal = { version = "0.4", features = ["gpio_cdev"] }
 
 [profile.release]
 lto = true

src/app_mode.rs

@@ -1,12 +1,12 @@
-use crate::hal::{blocking::delay::DelayUs, digital::v2::OutputPin};
+use crate::hal::{delay::DelayNs, digital::OutputPin};
 use crate::{
     hal, mode, register_access::get_errors, AlgorithmResult, BitFlags, Ccs811, Ccs811AppMode,
     Ccs811Awake, Error, ErrorAwake, InterruptMode, MeasurementMode, ModeChangeError, Register,
 };
 
 impl<I2C, E> Ccs811AppMode for Ccs811Awake<I2C, mode::App>
 where
-    I2C: hal::blocking::i2c::Write<Error = E> + hal::blocking::i2c::WriteRead<Error = E>,
+    I2C: hal::i2c::I2c<Error = E>,
 {
     type Error = ErrorAwake<E>;
     type ModeChangeError = ModeChangeError<ErrorAwake<E>, Self>;
@@ -164,9 +164,9 @@ fn handle_raw_data(data0: u8, data1: u8) -> (u8, u16) {
 
 impl<I2C, CommE, PinE, NWAKE, WAKEDELAY> Ccs811AppMode for Ccs811<I2C, NWAKE, WAKEDELAY, mode::App>
 where
-    I2C: hal::blocking::i2c::Write<Error = CommE> + hal::blocking::i2c::WriteRead<Error = CommE>,
+    I2C: hal::i2c::I2c<Error = CommE>,
     NWAKE: OutputPin<Error = PinE>,
-    WAKEDELAY: DelayUs<u8>,
+    WAKEDELAY: DelayNs,
 {
     type Error = Error<CommE, PinE>;
     type ModeChangeError = ModeChangeError<Error<CommE, PinE>, Self>;

src/boot_mode.rs

@@ -1,15 +1,12 @@
-use crate::hal::{
-    blocking::delay::{DelayMs, DelayUs},
-    digital::v2::OutputPin,
-};
+use crate::hal::{delay::DelayNs, digital::OutputPin};
 use crate::{
     hal, mode, ActionInProgress, BitFlags, Ccs811, Ccs811Awake, Ccs811BootMode, Ccs811Device,
     Error, ErrorAwake, ModeChangeError, Register,
 };
 
 impl<I2C, E> Ccs811BootMode for Ccs811Awake<I2C, mode::Boot>
 where
-    I2C: hal::blocking::i2c::Write<Error = E> + hal::blocking::i2c::WriteRead<Error = E>,
+    I2C: hal::i2c::I2c<Error = E>,
 {
     type Error = ErrorAwake<E>;
     type ModeChangeError = ModeChangeError<Self::Error, Self>;
@@ -81,7 +78,7 @@ where
         }
     }
 
-    fn download_application<D: DelayMs<u16>>(
+    fn download_application<D: DelayNs>(
         &mut self,
         bin: &[u8],
         delay: &mut D,
@@ -101,7 +98,7 @@ where
         self.check_status_error()
     }
 
-    fn update_application<D: DelayMs<u16>>(
+    fn update_application<D: DelayNs>(
         &mut self,
         bin: &[u8],
         delay: &mut D,
@@ -135,9 +132,9 @@ where
 impl<I2C, CommE, PinE, NWAKE, WAKEDELAY> Ccs811BootMode
     for Ccs811<I2C, NWAKE, WAKEDELAY, mode::Boot>
 where
-    I2C: hal::blocking::i2c::Write<Error = CommE> + hal::blocking::i2c::WriteRead<Error = CommE>,
+    I2C: hal::i2c::I2c<Error = CommE>,
     NWAKE: OutputPin<Error = PinE>,
-    WAKEDELAY: DelayUs<u8>,
+    WAKEDELAY: DelayNs,
 {
     type Error = Error<CommE, PinE>;
     type ModeChangeError = ModeChangeError<Self::Error, Self>;
@@ -155,15 +152,15 @@ where
         self.on_awaken_nb(|s| s.dev.erase_application())
     }
 
-    fn download_application<D: DelayMs<u16>>(
+    fn download_application<D: DelayNs>(
         &mut self,
         bin: &[u8],
         delay: &mut D,
     ) -> Result<(), Self::Error> {
         self.on_awaken(|s| s.dev.download_application(bin, delay))
     }
 
-    fn update_application<D: DelayMs<u16>>(
+    fn update_application<D: DelayNs>(
         &mut self,
         bin: &[u8],
         delay: &mut D,

src/common_impl.rs

@@ -1,4 +1,4 @@
-use crate::hal::{blocking::delay::DelayUs, digital::v2::OutputPin};
+use crate::hal::{delay::DelayNs, digital::OutputPin};
 use crate::{
     hal, mode, ActionInProgress, BitFlags, Ccs811, Ccs811Awake, Ccs811Device, Error, ErrorAwake,
     FirmwareMode, ModeChangeError, Register, SlaveAddr,
@@ -54,7 +54,7 @@ impl<I2C, MODE> Ccs811Awake<I2C, MODE> {
 
 impl<I2C, E, MODE> Ccs811Awake<I2C, MODE>
 where
-    I2C: hal::blocking::i2c::Write<Error = E>,
+    I2C: hal::i2c::I2c<Error = E>,
 {
     /// Destroy driver instance, return I²C bus instance.
     pub fn destroy(self) -> I2C {
@@ -63,7 +63,7 @@ where
 }
 impl<I2C, E, MODE> Ccs811Awake<I2C, MODE>
 where
-    I2C: hal::blocking::i2c::Write<Error = E> + hal::blocking::i2c::WriteRead<Error = E>,
+    I2C: hal::i2c::I2c<Error = E>,
 {
     pub(crate) fn write_sw_reset(&mut self) -> Result<(), ErrorAwake<E>> {
         self.i2c
@@ -74,9 +74,9 @@ where
 
 impl<I2C, CommE, PinE, NWAKE, WAKEDELAY, MODE> Ccs811<I2C, NWAKE, WAKEDELAY, MODE>
 where
-    I2C: hal::blocking::i2c::Write<Error = CommE>,
+    I2C: hal::i2c::I2c<Error = CommE>,
     NWAKE: OutputPin<Error = PinE>,
-    WAKEDELAY: DelayUs<u8>,
+    WAKEDELAY: DelayNs,
 {
     /// Destroy driver instance, return I²C bus, nWAKE pin
     /// and wake delay instances.
@@ -173,7 +173,7 @@ where
 
 impl<I2C, E, MODE> Ccs811Device for Ccs811Awake<I2C, MODE>
 where
-    I2C: hal::blocking::i2c::Write<Error = E> + hal::blocking::i2c::WriteRead<Error = E>,
+    I2C: hal::i2c::I2c<Error = E>,
 {
     type Error = ErrorAwake<E>;
 
@@ -214,9 +214,9 @@ where
 
 impl<I2C, CommE, PinE, NWAKE, WAKEDELAY, MODE> Ccs811Device for Ccs811<I2C, NWAKE, WAKEDELAY, MODE>
 where
-    I2C: hal::blocking::i2c::Write<Error = CommE> + hal::blocking::i2c::WriteRead<Error = CommE>,
+    I2C: hal::i2c::I2c<Error = CommE>,
     NWAKE: OutputPin<Error = PinE>,
-    WAKEDELAY: DelayUs<u8>,
+    WAKEDELAY: DelayNs,
 {
     type Error = Error<CommE, PinE>;
 

src/lib.rs

@@ -104,12 +104,16 @@
 //! ### Start the application and take measurements
 //!
 //! ```no_run
-//! use linux_embedded_hal::{I2cdev, Pin, Delay};
+//! use linux_embedded_hal::{I2cdev, CdevPin, Delay};
+//! use linux_embedded_hal::gpio_cdev::{Chip, LineRequestFlags};
 //! use embedded_ccs811::{prelude::*, Ccs811, SlaveAddr, MeasurementMode};
 //! use nb::block;
 //!
 //! let dev = I2cdev::new("/dev/i2c-1").unwrap();
-//! let nwake = Pin::new(17);
+//! let mut chip = Chip::new("/dev/gpiochip0").unwrap();
+//! let handle = chip.get_line(17).unwrap()
+//!   .request(LineRequestFlags::OUTPUT, 0, "output").unwrap();
+//! let nwake = CdevPin::new(handle).unwrap();
 //! let delay = Delay {};
 //! let address = SlaveAddr::default();
 //! let sensor = Ccs811::new(dev, address, nwake, delay);

src/register_access.rs

@@ -41,7 +41,7 @@ impl BitFlags {
 
 impl<I2C, E, MODE> Ccs811Awake<I2C, MODE>
 where
-    I2C: hal::blocking::i2c::Write<Error = E> + hal::blocking::i2c::WriteRead<Error = E>,
+    I2C: hal::i2c::I2c<Error = E>,
 {
     pub(crate) fn check_status_error(&mut self) -> Result<(), ErrorAwake<E>> {
         self.read_status().map(drop)

src/traits.rs

@@ -1,5 +1,5 @@
 use crate::{private, AlgorithmResult, FirmwareMode, InterruptMode, MeasurementMode};
-use embedded_hal::blocking::delay::DelayMs;
+use embedded_hal::delay::DelayNs;
 
 /// General CCS811 methods available in either mode
 pub trait Ccs811Device: private::Sealed {
@@ -114,7 +114,7 @@ pub trait Ccs811BootMode: private::Sealed {
     /// This resets the device via a software reset, erases the current application,
     /// flashes the new binary and verifies it. This takes at least 572ms + 50ms * (bin_size/8).
     /// Returns `Error::InvalidInputData` if the input binary lengh is not multiple of 8.
-    fn update_application<D: DelayMs<u16>>(
+    fn update_application<D: DelayNs>(
         &mut self,
         bin: &[u8],
         delay: &mut D,
@@ -136,7 +136,7 @@ pub trait Ccs811BootMode: private::Sealed {
     ///
     /// Returns `Error::InvalidInputData` if the input binary lengh is not multiple of 8.
     /// This takes at least 50ms * (bin_size/8).
-    fn download_application<D: DelayMs<u16>>(
+    fn download_application<D: DelayNs>(
         &mut self,
         bin: &[u8],
         delay: &mut D,

tests/app_mode.rs

@@ -1,10 +1,10 @@
 use embedded_ccs811::{
     mode, prelude::*, AlgorithmResult, Ccs811, Error, InterruptMode, MeasurementMode,
 };
-use embedded_hal_mock::{
-    delay::MockNoop as NoDelay,
+use embedded_hal_mock::eh1::{
+    delay::NoopDelay as NoDelay,
+    digital::{Mock as PinMock, State as PinState, Transaction as PinTrans},
     i2c::{Mock as I2cMock, Transaction as I2cTrans},
-    pin::{Mock as PinMock, State as PinState, Transaction as PinTrans},
 };
 mod common;
 use crate::common::{destroy, new, BitFlags as BF, Register, DEV_ADDR};