mirror of https://github.com/eldruin/ds323x-rs
Initial version
Diego Barrios Romero
commit
9532c1b462
|
|
@ -0,0 +1,6 @@
|
||||||
|
**/*.rs.bk
|
||||||
|
.#*
|
||||||
|
/target/
|
||||||
|
Cargo.lock
|
||||||
|
.gdb_history
|
||||||
|
|
||||||
|
|
@ -0,0 +1,11 @@
|
||||||
|
# Changelog
|
||||||
|
|
||||||
|
All notable changes to this project will be documented in this file.
|
||||||
|
|
||||||
|
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
|
||||||
|
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
|
||||||
|
|
||||||
|
## [Unreleased]
|
||||||
|
|
||||||
|
...
|
||||||
|
|
||||||
|
|
@ -0,0 +1,34 @@
|
||||||
|
[package]
|
||||||
|
name = "ds323x"
|
||||||
|
version = "0.1.0"
|
||||||
|
authors = ["Diego Barrios Romero <eldruin@gmail.com>"]
|
||||||
|
repository = "https://github.com/eldruin/ds323x-rs"
|
||||||
|
license = "MIT OR Apache-2.0"
|
||||||
|
description = "Platform-agnostic Rust driver for the DS3231, DS3232 and DS3234 extremely accurate real-time clocks (RTC)."
|
||||||
|
readme = "README.md"
|
||||||
|
keywords = ["rtc", "clock", "real-time", "driver", "embedded-hal-driver"]
|
||||||
|
categories = ["embedded", "hardware-support", "no-std"]
|
||||||
|
homepage = "https://github.com/eldruin/ds323x-rs"
|
||||||
|
documentation = "https://docs.rs/ds323x"
|
||||||
|
include = [
|
||||||
|
"**/*.rs",
|
||||||
|
"Cargo.toml",
|
||||||
|
"README.md",
|
||||||
|
"CHANGELOG.md",
|
||||||
|
"LICENSE-MIT",
|
||||||
|
"LICENSE-APACHE",
|
||||||
|
]
|
||||||
|
|
||||||
|
[badges.travis-ci]
|
||||||
|
branch = "master"
|
||||||
|
repository = "eldruin/ds323x-rs"
|
||||||
|
|
||||||
|
[dependencies]
|
||||||
|
embedded-hal = "0.2"
|
||||||
|
|
||||||
|
[dev-dependencies]
|
||||||
|
linux-embedded-hal = "0.2"
|
||||||
|
embedded-hal-mock = "0.4"
|
||||||
|
|
||||||
|
[profile.release]
|
||||||
|
lto = true
|
||||||
|
|
@ -0,0 +1,176 @@
|
||||||
|
Apache License
|
||||||
|
Version 2.0, January 2004
|
||||||
|
http://www.apache.org/licenses/
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||||
|
|
||||||
|
1. Definitions.
|
||||||
|
|
||||||
|
"License" shall mean the terms and conditions for use, reproduction,
|
||||||
|
and distribution as defined by Sections 1 through 9 of this document.
|
||||||
|
|
||||||
|
"Licensor" shall mean the copyright owner or entity authorized by
|
||||||
|
the copyright owner that is granting the License.
|
||||||
|
|
||||||
|
"Legal Entity" shall mean the union of the acting entity and all
|
||||||
|
other entities that control, are controlled by, or are under common
|
||||||
|
control with that entity. For the purposes of this definition,
|
||||||
|
"control" means (i) the power, direct or indirect, to cause the
|
||||||
|
direction or management of such entity, whether by contract or
|
||||||
|
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||||
|
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||||
|
|
||||||
|
"You" (or "Your") shall mean an individual or Legal Entity
|
||||||
|
exercising permissions granted by this License.
|
||||||
|
|
||||||
|
"Source" form shall mean the preferred form for making modifications,
|
||||||
|
including but not limited to software source code, documentation
|
||||||
|
source, and configuration files.
|
||||||
|
|
||||||
|
"Object" form shall mean any form resulting from mechanical
|
||||||
|
transformation or translation of a Source form, including but
|
||||||
|
not limited to compiled object code, generated documentation,
|
||||||
|
and conversions to other media types.
|
||||||
|
|
||||||
|
"Work" shall mean the work of authorship, whether in Source or
|
||||||
|
Object form, made available under the License, as indicated by a
|
||||||
|
copyright notice that is included in or attached to the work
|
||||||
|
(an example is provided in the Appendix below).
|
||||||
|
|
||||||
|
"Derivative Works" shall mean any work, whether in Source or Object
|
||||||
|
form, that is based on (or derived from) the Work and for which the
|
||||||
|
editorial revisions, annotations, elaborations, or other modifications
|
||||||
|
represent, as a whole, an original work of authorship. For the purposes
|
||||||
|
of this License, Derivative Works shall not include works that remain
|
||||||
|
separable from, or merely link (or bind by name) to the interfaces of,
|
||||||
|
the Work and Derivative Works thereof.
|
||||||
|
|
||||||
|
"Contribution" shall mean any work of authorship, including
|
||||||
|
the original version of the Work and any modifications or additions
|
||||||
|
to that Work or Derivative Works thereof, that is intentionally
|
||||||
|
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||||
|
or by an individual or Legal Entity authorized to submit on behalf of
|
||||||
|
the copyright owner. For the purposes of this definition, "submitted"
|
||||||
|
means any form of electronic, verbal, or written communication sent
|
||||||
|
to the Licensor or its representatives, including but not limited to
|
||||||
|
communication on electronic mailing lists, source code control systems,
|
||||||
|
and issue tracking systems that are managed by, or on behalf of, the
|
||||||
|
Licensor for the purpose of discussing and improving the Work, but
|
||||||
|
excluding communication that is conspicuously marked or otherwise
|
||||||
|
designated in writing by the copyright owner as "Not a Contribution."
|
||||||
|
|
||||||
|
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||||
|
on behalf of whom a Contribution has been received by Licensor and
|
||||||
|
subsequently incorporated within the Work.
|
||||||
|
|
||||||
|
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
copyright license to reproduce, prepare Derivative Works of,
|
||||||
|
publicly display, publicly perform, sublicense, and distribute the
|
||||||
|
Work and such Derivative Works in Source or Object form.
|
||||||
|
|
||||||
|
3. Grant of Patent License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
(except as stated in this section) patent license to make, have made,
|
||||||
|
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||||
|
where such license applies only to those patent claims licensable
|
||||||
|
by such Contributor that are necessarily infringed by their
|
||||||
|
Contribution(s) alone or by combination of their Contribution(s)
|
||||||
|
with the Work to which such Contribution(s) was submitted. If You
|
||||||
|
institute patent litigation against any entity (including a
|
||||||
|
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||||
|
or a Contribution incorporated within the Work constitutes direct
|
||||||
|
or contributory patent infringement, then any patent licenses
|
||||||
|
granted to You under this License for that Work shall terminate
|
||||||
|
as of the date such litigation is filed.
|
||||||
|
|
||||||
|
4. Redistribution. You may reproduce and distribute copies of the
|
||||||
|
Work or Derivative Works thereof in any medium, with or without
|
||||||
|
modifications, and in Source or Object form, provided that You
|
||||||
|
meet the following conditions:
|
||||||
|
|
||||||
|
(a) You must give any other recipients of the Work or
|
||||||
|
Derivative Works a copy of this License; and
|
||||||
|
|
||||||
|
(b) You must cause any modified files to carry prominent notices
|
||||||
|
stating that You changed the files; and
|
||||||
|
|
||||||
|
(c) You must retain, in the Source form of any Derivative Works
|
||||||
|
that You distribute, all copyright, patent, trademark, and
|
||||||
|
attribution notices from the Source form of the Work,
|
||||||
|
excluding those notices that do not pertain to any part of
|
||||||
|
the Derivative Works; and
|
||||||
|
|
||||||
|
(d) If the Work includes a "NOTICE" text file as part of its
|
||||||
|
distribution, then any Derivative Works that You distribute must
|
||||||
|
include a readable copy of the attribution notices contained
|
||||||
|
within such NOTICE file, excluding those notices that do not
|
||||||
|
pertain to any part of the Derivative Works, in at least one
|
||||||
|
of the following places: within a NOTICE text file distributed
|
||||||
|
as part of the Derivative Works; within the Source form or
|
||||||
|
documentation, if provided along with the Derivative Works; or,
|
||||||
|
within a display generated by the Derivative Works, if and
|
||||||
|
wherever such third-party notices normally appear. The contents
|
||||||
|
of the NOTICE file are for informational purposes only and
|
||||||
|
do not modify the License. You may add Your own attribution
|
||||||
|
notices within Derivative Works that You distribute, alongside
|
||||||
|
or as an addendum to the NOTICE text from the Work, provided
|
||||||
|
that such additional attribution notices cannot be construed
|
||||||
|
as modifying the License.
|
||||||
|
|
||||||
|
You may add Your own copyright statement to Your modifications and
|
||||||
|
may provide additional or different license terms and conditions
|
||||||
|
for use, reproduction, or distribution of Your modifications, or
|
||||||
|
for any such Derivative Works as a whole, provided Your use,
|
||||||
|
reproduction, and distribution of the Work otherwise complies with
|
||||||
|
the conditions stated in this License.
|
||||||
|
|
||||||
|
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||||
|
any Contribution intentionally submitted for inclusion in the Work
|
||||||
|
by You to the Licensor shall be under the terms and conditions of
|
||||||
|
this License, without any additional terms or conditions.
|
||||||
|
Notwithstanding the above, nothing herein shall supersede or modify
|
||||||
|
the terms of any separate license agreement you may have executed
|
||||||
|
with Licensor regarding such Contributions.
|
||||||
|
|
||||||
|
6. Trademarks. This License does not grant permission to use the trade
|
||||||
|
names, trademarks, service marks, or product names of the Licensor,
|
||||||
|
except as required for reasonable and customary use in describing the
|
||||||
|
origin of the Work and reproducing the content of the NOTICE file.
|
||||||
|
|
||||||
|
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||||
|
agreed to in writing, Licensor provides the Work (and each
|
||||||
|
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||||
|
implied, including, without limitation, any warranties or conditions
|
||||||
|
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||||
|
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||||
|
appropriateness of using or redistributing the Work and assume any
|
||||||
|
risks associated with Your exercise of permissions under this License.
|
||||||
|
|
||||||
|
8. Limitation of Liability. In no event and under no legal theory,
|
||||||
|
whether in tort (including negligence), contract, or otherwise,
|
||||||
|
unless required by applicable law (such as deliberate and grossly
|
||||||
|
negligent acts) or agreed to in writing, shall any Contributor be
|
||||||
|
liable to You for damages, including any direct, indirect, special,
|
||||||
|
incidental, or consequential damages of any character arising as a
|
||||||
|
result of this License or out of the use or inability to use the
|
||||||
|
Work (including but not limited to damages for loss of goodwill,
|
||||||
|
work stoppage, computer failure or malfunction, or any and all
|
||||||
|
other commercial damages or losses), even if such Contributor
|
||||||
|
has been advised of the possibility of such damages.
|
||||||
|
|
||||||
|
9. Accepting Warranty or Additional Liability. While redistributing
|
||||||
|
the Work or Derivative Works thereof, You may choose to offer,
|
||||||
|
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||||
|
or other liability obligations and/or rights consistent with this
|
||||||
|
License. However, in accepting such obligations, You may act only
|
||||||
|
on Your own behalf and on Your sole responsibility, not on behalf
|
||||||
|
of any other Contributor, and only if You agree to indemnify,
|
||||||
|
defend, and hold each Contributor harmless for any liability
|
||||||
|
incurred by, or claims asserted against, such Contributor by reason
|
||||||
|
of your accepting any such warranty or additional liability.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
@ -0,0 +1,19 @@
|
||||||
|
Copyright (C) 2018 Diego Barrios Romero
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||||
|
this software and associated documentation files (the "Software"), to deal in
|
||||||
|
the Software without restriction, including without limitation the rights to
|
||||||
|
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
|
||||||
|
of the Software, and to permit persons to whom the Software is furnished to do
|
||||||
|
so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
||||||
|
|
@ -0,0 +1,44 @@
|
||||||
|
# Rust DS3231, DS3232 and DS3234 Extremely Accurate Real-Time Clock Driver [](https://crates.io/crates/ds323x) [](https://docs.rs/ds323x) [](https://travis-ci.org/eldruin/ds323x-rs)
|
||||||
|
|
||||||
|
This is a platform agnostic Rust driver for the DS3231, DS3232 and DS3234
|
||||||
|
extremely accurate real-time clocks, based on the [`embedded-hal`] traits.
|
||||||
|
|
||||||
|
[`embedded-hal`]: https://github.com/rust-embedded/embedded-hal
|
||||||
|
|
||||||
|
This driver allows you to:
|
||||||
|
- Read/write the seconds.
|
||||||
|
|
||||||
|
## The devices
|
||||||
|
|
||||||
|
This driver is compatible with the DS3231 and DS3232 I2C devices and the
|
||||||
|
DS3234 SPI device.
|
||||||
|
|
||||||
|
### DS3231
|
||||||
|
TODO
|
||||||
|
|
||||||
|
### DS3232
|
||||||
|
TODO
|
||||||
|
|
||||||
|
### DS3234
|
||||||
|
TODO
|
||||||
|
|
||||||
|
Datasheets:
|
||||||
|
- [DS3231](https://datasheets.maximintegrated.com/en/ds/DS3231.pdf)
|
||||||
|
- [DS3232](https://datasheets.maximintegrated.com/en/ds/DS3232.pdf)
|
||||||
|
- [DS3234](https://datasheets.maximintegrated.com/en/ds/DS3234.pdf)
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
Licensed under either of
|
||||||
|
|
||||||
|
* Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0)
|
||||||
|
* MIT license ([LICENSE-MIT](LICENSE-MIT) or
|
||||||
|
http://opensource.org/licenses/MIT) at your option.
|
||||||
|
|
||||||
|
### Contributing
|
||||||
|
|
||||||
|
Unless you explicitly state otherwise, any contribution intentionally submitted
|
||||||
|
for inclusion in the work by you, as defined in the Apache-2.0 license, shall
|
||||||
|
be dual licensed as above, without any additional terms or conditions.
|
||||||
|
|
||||||
|
|
@ -0,0 +1,69 @@
|
||||||
|
//! Common implementation
|
||||||
|
|
||||||
|
#![deny(missing_docs)]
|
||||||
|
|
||||||
|
extern crate embedded_hal as hal;
|
||||||
|
use super::{ Ds323x, Register, Error };
|
||||||
|
use interface::{ ReadRegister, WriteRegister };
|
||||||
|
|
||||||
|
impl<DI, IC, E> Ds323x<DI, IC>
|
||||||
|
where
|
||||||
|
DI: ReadRegister<Error = E> + WriteRegister<Error = E>
|
||||||
|
{
|
||||||
|
/// Read the seconds.
|
||||||
|
pub fn get_seconds(&mut self) -> Result<u8, Error<E>> {
|
||||||
|
let data = self.iface.read_register(Register::SECONDS)?;
|
||||||
|
Ok(packed_bcd_to_decimal(data))
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Set the seconds [0-59].
|
||||||
|
///
|
||||||
|
/// Will return an `Error::InvalidInputData` if the seconds are out of range.
|
||||||
|
pub fn set_seconds(&mut self, seconds: u8) -> Result<(), Error<E>> {
|
||||||
|
if seconds > 59 {
|
||||||
|
return Err(Error::InvalidInputData);
|
||||||
|
}
|
||||||
|
self.iface.write_register(Register::SECONDS, decimal_to_packed_bcd(seconds))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Transforms a decimal number to packed BCD format
|
||||||
|
fn decimal_to_packed_bcd(dec: u8) -> u8 {
|
||||||
|
((dec / 10) << 4) | (dec % 10)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Transforms a number in packed BCD format to decimal
|
||||||
|
fn packed_bcd_to_decimal(bcd: u8) -> u8 {
|
||||||
|
(bcd >> 4) * 10 + (bcd & 0xF)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::*;
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn can_convert_packed_bcd_to_decimal() {
|
||||||
|
assert_eq!(0, packed_bcd_to_decimal(0b0000_0000));
|
||||||
|
assert_eq!(1, packed_bcd_to_decimal(0b0000_0001));
|
||||||
|
assert_eq!(9, packed_bcd_to_decimal(0b0000_1001));
|
||||||
|
assert_eq!(10, packed_bcd_to_decimal(0b0001_0000));
|
||||||
|
assert_eq!(11, packed_bcd_to_decimal(0b0001_0001));
|
||||||
|
assert_eq!(19, packed_bcd_to_decimal(0b0001_1001));
|
||||||
|
assert_eq!(20, packed_bcd_to_decimal(0b0010_0000));
|
||||||
|
assert_eq!(21, packed_bcd_to_decimal(0b0010_0001));
|
||||||
|
assert_eq!(59, packed_bcd_to_decimal(0b0101_1001));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn can_convert_decimal_to_packed_bcd() {
|
||||||
|
assert_eq!(0b0000_0000, decimal_to_packed_bcd( 0));
|
||||||
|
assert_eq!(0b0000_0001, decimal_to_packed_bcd( 1));
|
||||||
|
assert_eq!(0b0000_1001, decimal_to_packed_bcd( 9));
|
||||||
|
assert_eq!(0b0001_0000, decimal_to_packed_bcd(10));
|
||||||
|
assert_eq!(0b0001_0001, decimal_to_packed_bcd(11));
|
||||||
|
assert_eq!(0b0001_1001, decimal_to_packed_bcd(19));
|
||||||
|
assert_eq!(0b0010_0000, decimal_to_packed_bcd(20));
|
||||||
|
assert_eq!(0b0010_0001, decimal_to_packed_bcd(21));
|
||||||
|
assert_eq!(0b0101_1001, decimal_to_packed_bcd(59));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,103 @@
|
||||||
|
//! I2C/SPI interfaces
|
||||||
|
|
||||||
|
#![deny(missing_docs)]
|
||||||
|
|
||||||
|
extern crate embedded_hal as hal;
|
||||||
|
use hal::blocking;
|
||||||
|
use super::{ DEVICE_ADDRESS, Error };
|
||||||
|
|
||||||
|
/// I2C interface
|
||||||
|
#[derive(Debug, Default)]
|
||||||
|
pub struct I2cInterface<I2C> {
|
||||||
|
pub(crate) i2c: I2C,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// SPI interface
|
||||||
|
#[derive(Debug, Default)]
|
||||||
|
pub struct SpiInterface<SPI, CS> {
|
||||||
|
pub(crate) spi: SPI,
|
||||||
|
pub(crate) cs: CS
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Write to a register
|
||||||
|
pub trait WriteRegister {
|
||||||
|
/// Error type
|
||||||
|
type Error;
|
||||||
|
/// Write to an u8 register
|
||||||
|
fn write_register(&mut self, register: u8, data: u8) -> Result<(), Error<Self::Error>>;
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<I2C, E> WriteRegister for I2cInterface<I2C>
|
||||||
|
where
|
||||||
|
I2C: blocking::i2c::Write<Error = E>
|
||||||
|
{
|
||||||
|
type Error = E;
|
||||||
|
fn write_register(&mut self, register: u8, data: u8) -> Result<(), Error<E>> {
|
||||||
|
let payload: [u8; 2] = [register, data];
|
||||||
|
self.i2c
|
||||||
|
.write(DEVICE_ADDRESS, &payload)
|
||||||
|
.map_err(Error::Comm)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<SPI, CS, E> WriteRegister for SpiInterface<SPI, CS>
|
||||||
|
where
|
||||||
|
SPI: blocking::spi::Write<u8, Error = E>,
|
||||||
|
CS: hal::digital::OutputPin
|
||||||
|
{
|
||||||
|
type Error = E;
|
||||||
|
fn write_register(&mut self, register: u8, data: u8) -> Result<(), Error<E>> {
|
||||||
|
self.cs.set_low();
|
||||||
|
|
||||||
|
let payload: [u8; 2] = [register + 0x80, data];
|
||||||
|
let result = self.spi
|
||||||
|
.write(&payload)
|
||||||
|
.map_err(Error::Comm);
|
||||||
|
|
||||||
|
self.cs.set_high();
|
||||||
|
result
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/// Read a register
|
||||||
|
pub trait ReadRegister {
|
||||||
|
/// Error type
|
||||||
|
type Error;
|
||||||
|
/// Read an u8 register
|
||||||
|
fn read_register(&mut self, register: u8) -> Result<u8, Error<Self::Error>>;
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<I2C, E> ReadRegister for I2cInterface<I2C>
|
||||||
|
where
|
||||||
|
I2C: blocking::i2c::WriteRead<Error = E>
|
||||||
|
{
|
||||||
|
type Error = E;
|
||||||
|
fn read_register(&mut self, register: u8) -> Result<u8, Error<E>> {
|
||||||
|
let mut data = [0];
|
||||||
|
self.i2c
|
||||||
|
.write_read(DEVICE_ADDRESS, &[register], &mut data)
|
||||||
|
.map_err(Error::Comm)
|
||||||
|
.and(Ok(data[0]))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<SPI, CS, E> ReadRegister for SpiInterface<SPI, CS>
|
||||||
|
where
|
||||||
|
SPI: blocking::spi::Transfer<u8, Error = E>,
|
||||||
|
CS: hal::digital::OutputPin
|
||||||
|
{
|
||||||
|
type Error = E;
|
||||||
|
fn read_register(&mut self, register: u8) -> Result<u8, Error<E>> {
|
||||||
|
self.cs.set_low();
|
||||||
|
let mut data = [register, 0];
|
||||||
|
{
|
||||||
|
let result = self.spi
|
||||||
|
.transfer(&mut data)
|
||||||
|
.map_err(Error::Comm);
|
||||||
|
self.cs.set_high();
|
||||||
|
result?;
|
||||||
|
}
|
||||||
|
Ok(data[1])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,229 @@
|
||||||
|
//! This is a platform agnostic Rust driver for the DS3231, DS3232 and DS3234
|
||||||
|
//! extremely accurate real-time clocks, based on the [`embedded-hal`] traits.
|
||||||
|
//!
|
||||||
|
//! [`embedded-hal`]: https://github.com/rust-embedded/embedded-hal
|
||||||
|
//!
|
||||||
|
//! This driver allows you to:
|
||||||
|
//! - Read/write the seconds.
|
||||||
|
//!
|
||||||
|
//! ## The devices
|
||||||
|
//!
|
||||||
|
//! This driver is compatible with the DS3231 and DS3232 I2C devices and the
|
||||||
|
//! DS3234 SPI device.
|
||||||
|
//!
|
||||||
|
//! ### DS3231
|
||||||
|
//! TODO
|
||||||
|
//!
|
||||||
|
//! ### DS3232
|
||||||
|
//! TODO
|
||||||
|
//!
|
||||||
|
//! ### DS3234
|
||||||
|
//! TODO
|
||||||
|
//!
|
||||||
|
//! Datasheets:
|
||||||
|
//! - [DS3231](https://datasheets.maximintegrated.com/en/ds/DS3231.pdf)
|
||||||
|
//! - [DS3232](https://datasheets.maximintegrated.com/en/ds/DS3232.pdf)
|
||||||
|
//! - [DS3234](https://datasheets.maximintegrated.com/en/ds/DS3234.pdf)
|
||||||
|
//!
|
||||||
|
|
||||||
|
#![deny(unsafe_code)]
|
||||||
|
#![deny(missing_docs)]
|
||||||
|
#![no_std]
|
||||||
|
|
||||||
|
extern crate embedded_hal as hal;
|
||||||
|
use hal::blocking;
|
||||||
|
use core::marker::PhantomData;
|
||||||
|
|
||||||
|
/// All possible errors in this crate
|
||||||
|
#[derive(Debug)]
|
||||||
|
pub enum Error<E> {
|
||||||
|
/// I²C/SPI bus error
|
||||||
|
Comm(E),
|
||||||
|
/// Invalid input data provided
|
||||||
|
InvalidInputData
|
||||||
|
}
|
||||||
|
|
||||||
|
struct Register;
|
||||||
|
|
||||||
|
impl Register {
|
||||||
|
const SECONDS : u8 = 0x00;
|
||||||
|
}
|
||||||
|
|
||||||
|
const DEVICE_ADDRESS: u8 = 0b110_1000;
|
||||||
|
|
||||||
|
/// IC markers
|
||||||
|
pub mod ic {
|
||||||
|
/// DS3231 IC marker
|
||||||
|
pub struct DS3231;
|
||||||
|
/// DS3232 IC marker
|
||||||
|
pub struct DS3232;
|
||||||
|
/// DS3234 IC marker
|
||||||
|
pub struct DS3234;
|
||||||
|
}
|
||||||
|
pub mod interface;
|
||||||
|
use interface::{ I2cInterface, SpiInterface };
|
||||||
|
|
||||||
|
/// DS3231, DS3232 and DS3234 RTC driver
|
||||||
|
#[derive(Debug, Default)]
|
||||||
|
pub struct Ds323x<DI, IC> {
|
||||||
|
iface: DI,
|
||||||
|
_ic: PhantomData<IC>
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<I2C, E> Ds323x<I2cInterface<I2C>, ic::DS3231>
|
||||||
|
where
|
||||||
|
I2C: blocking::i2c::Write<Error = E> + blocking::i2c::WriteRead<Error = E>
|
||||||
|
{
|
||||||
|
/// Create a new instance of the DS3231 device.
|
||||||
|
pub fn new_ds3231(i2c: I2C) -> Self {
|
||||||
|
Ds323x {
|
||||||
|
iface: I2cInterface {
|
||||||
|
i2c,
|
||||||
|
},
|
||||||
|
_ic: PhantomData
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Destroy driver instance, return I²C bus instance.
|
||||||
|
pub fn destroy_ds3231(self) -> I2C {
|
||||||
|
self.iface.i2c
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<I2C, E> Ds323x<I2cInterface<I2C>, ic::DS3232>
|
||||||
|
where
|
||||||
|
I2C: blocking::i2c::Write<Error = E> + blocking::i2c::WriteRead<Error = E>
|
||||||
|
{
|
||||||
|
/// Create a new instance of the DS3232 device.
|
||||||
|
pub fn new_ds3232(i2c: I2C) -> Self {
|
||||||
|
Ds323x {
|
||||||
|
iface: I2cInterface {
|
||||||
|
i2c,
|
||||||
|
},
|
||||||
|
_ic: PhantomData
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Destroy driver instance, return I²C bus instance.
|
||||||
|
pub fn destroy_ds3232(self) -> I2C {
|
||||||
|
self.iface.i2c
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<SPI, CS, E> Ds323x<SpiInterface<SPI, CS>, ic::DS3234>
|
||||||
|
where
|
||||||
|
SPI: blocking::spi::Transfer<u8, Error = E> + blocking::spi::Write<u8, Error = E>,
|
||||||
|
CS: hal::digital::OutputPin
|
||||||
|
{
|
||||||
|
/// Create a new instance.
|
||||||
|
pub fn new_ds3234(spi: SPI, chip_select: CS) -> Self {
|
||||||
|
Ds323x {
|
||||||
|
iface: SpiInterface {
|
||||||
|
spi,
|
||||||
|
cs: chip_select
|
||||||
|
},
|
||||||
|
_ic: PhantomData
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Destroy driver instance, return SPI bus instance and CS output pin.
|
||||||
|
pub fn destroy_ds3234(self) -> (SPI, CS) {
|
||||||
|
(self.iface.spi, self.iface.cs)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
mod ds323x;
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::*;
|
||||||
|
extern crate embedded_hal_mock as hal;
|
||||||
|
extern crate std;
|
||||||
|
use self::std::vec;
|
||||||
|
|
||||||
|
struct DummyOutputPin;
|
||||||
|
impl embedded_hal::digital::OutputPin for DummyOutputPin {
|
||||||
|
fn set_low(&mut self) {}
|
||||||
|
fn set_high(&mut self) {}
|
||||||
|
}
|
||||||
|
|
||||||
|
mod ds3231 {
|
||||||
|
use super::*;
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn can_create() {
|
||||||
|
Ds323x::new_ds3231(hal::i2c::Mock::new(&[]));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn can_get_seconds() {
|
||||||
|
let transactions = [
|
||||||
|
hal::i2c::Transaction::write_read(DEVICE_ADDRESS, vec![Register::SECONDS], vec![1])
|
||||||
|
];
|
||||||
|
let mut dev = Ds323x::new_ds3231(hal::i2c::Mock::new(&transactions));
|
||||||
|
assert_eq!(1, dev.get_seconds().unwrap());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn can_set_seconds() {
|
||||||
|
let transactions = [
|
||||||
|
hal::i2c::Transaction::write(DEVICE_ADDRESS, vec![Register::SECONDS, 1])
|
||||||
|
];
|
||||||
|
let mut dev = Ds323x::new_ds3231(hal::i2c::Mock::new(&transactions));
|
||||||
|
dev.set_seconds(1).unwrap();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
mod ds3232 {
|
||||||
|
use super::*;
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn can_create() {
|
||||||
|
Ds323x::new_ds3232(hal::i2c::Mock::new(&[]));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn can_get_seconds() {
|
||||||
|
let transactions = [
|
||||||
|
hal::i2c::Transaction::write_read(DEVICE_ADDRESS, vec![Register::SECONDS], vec![1])
|
||||||
|
];
|
||||||
|
let mut dev = Ds323x::new_ds3232(hal::i2c::Mock::new(&transactions));
|
||||||
|
assert_eq!(1, dev.get_seconds().unwrap());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn can_set_seconds() {
|
||||||
|
let transactions = [
|
||||||
|
hal::i2c::Transaction::write(DEVICE_ADDRESS, vec![Register::SECONDS, 1])
|
||||||
|
];
|
||||||
|
let mut dev = Ds323x::new_ds3232(hal::i2c::Mock::new(&transactions));
|
||||||
|
dev.set_seconds(1).unwrap();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
mod ds3234 {
|
||||||
|
use super::*;
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn can_create() {
|
||||||
|
Ds323x::new_ds3234(hal::spi::Mock::new(&[]), DummyOutputPin);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn can_get_seconds() {
|
||||||
|
let transactions = [
|
||||||
|
hal::spi::Transaction::transfer(vec![Register::SECONDS, 0], vec![Register::SECONDS, 1])
|
||||||
|
];
|
||||||
|
let mut dev = Ds323x::new_ds3234(hal::spi::Mock::new(&transactions), DummyOutputPin);
|
||||||
|
assert_eq!(1, dev.get_seconds().unwrap());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn can_set_seconds() {
|
||||||
|
let transactions = [
|
||||||
|
hal::spi::Transaction::write(vec![Register::SECONDS + 0x80, 1])
|
||||||
|
];
|
||||||
|
let mut dev = Ds323x::new_ds3234(hal::spi::Mock::new(&transactions), DummyOutputPin);
|
||||||
|
dev.set_seconds(1).unwrap();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
Loading…
Reference in New Issue