Skip to content

I2cdevice/lm75 #20

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.

Sign up for GitHub

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

Open
dtreffenstaedt wants to merge 8 commits into
base: i2cdevices
Choose a base branch
from
Open

I2cdevice/lm75 #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
b5d596c
Added skeleton of LM75 class.
Apr 16, 2022
0725cfa
Merge branch 'dev' into i2cdevice/lm75
Apr 16, 2022
f582736
Added implementation of lm75 device
Apr 16, 2022
9f1c2e4
Added documentation to lm75 class
Apr 16, 2022
bf242d3
Applied clang-format
Apr 16, 2022
1cdb22e
Merge branch 'i2cdevices' into i2cdevice/lm75
Jul 31, 2022
49e7793
Updated use of i2c_tag_type alias
Jul 31, 2022
acc0b38
Merge branch 'i2cdevices' into i2cdevice/lm75
Jan 17, 2023
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
2 changes: 2 additions & 0 deletions cmake/targets/detector.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ set(DETECTOR_SOURCE_FILES
"${PROJECT_SRC_DIR}/serial/i2cdevice.cpp"
"${PROJECT_SRC_DIR}/serial/i2cbus.cpp"
"${PROJECT_SRC_DIR}/serial/i2cdevices/generalcall.cpp"
"${PROJECT_SRC_DIR}/serial/i2cdevices/lm75.cpp"
)

set(DETECTOR_HEADER_FILES
Expand All @@ -16,6 +17,7 @@ set(DETECTOR_HEADER_FILES
"${PROJECT_HEADER_DIR}/muonpi/serial/i2cbus.h"
"${PROJECT_HEADER_DIR}/muonpi/serial/i2ceeprom.h"
"${PROJECT_HEADER_DIR}/muonpi/serial/i2cdevices/generalcall.h"
"${PROJECT_HEADER_DIR}/muonpi/serial/i2cdevices/lm75.h"
)
if (NOT LIBMUONPI_FORMAT_ONLY)
if (LIBMUONPI_BUILD_DETECTOR) # libraries specific to the Detector library
Expand Down
119 changes: 119 additions & 0 deletions include/muonpi/serial/i2cdevices/lm75.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,119 @@
#ifndef MUONPI_SERIAL_I2CDEVICES_LM75_H
#define MUONPI_SERIAL_I2CDEVICES_LM75_H

#include "muonpi/addressrange.h"
#include "muonpi/serial/i2cdevice.h"

namespace muonpi::serial::devices {

/**
* @brief The lm75 class. Interaction for the LM75 Temperature Sensor.
* Closely follows the datasheet:
* https://datasheets.maximintegrated.com/en/ds/LM75.pdf
*/
class lm75 : public i2c_device {
public:
constexpr static address_range addresses {0b01001000, {0b111}};

/**
* @brief lm75
* @param bus_traffic The bus traffic object from the i2c_bus.
* @param path The path of the i2c bus file descriptor
* @param address The address to use
*/
lm75(traffic_t& bus_traffic, const std::string& path, i2c_device::address_type address);

/**
* @brief lm75 Attempts to automatically setup the device connection.
* @param bus_traffic The bus traffic object from the i2c_bus.
* @param path The path of the i2c bus file descriptor
*/
lm75(traffic_t& bus_traffic, const std::string& path);

/**
* @brief identify Attempts to positively identify the device.
* @return True if identification was successful.
*/
[[nodiscard]] auto identify() -> bool override;

template <std::uint8_t ADDR>
struct basic_temperature_r : public simple_register<std::uint16_t, std::uint8_t, ADDR> {
using value_type = typename simple_register<std::uint16_t, std::uint8_t, ADDR>::value_type;
using address_type =
typename simple_register<std::uint16_t, std::uint8_t, ADDR>::address_type;

value_type temperature : 9 {};
const value_type reserved : 7 {};

[[nodiscard]] constexpr auto value() const noexcept -> double {
return static_cast<double>(temperature) / 2.0;
}

[[nodiscard]] constexpr auto get() const noexcept -> value_type override {
return static_cast<value_type>(temperature << 7);
}

constexpr explicit basic_temperature_r(value_type v) noexcept
: temperature {static_cast<value_type>(v >> 7)}
, reserved {static_cast<value_type>(v & 0b1111111)} {}

constexpr explicit basic_temperature_r() noexcept = default;
};

struct temperature_r : public basic_temperature_r<0x00> {
constexpr static i2c_tag_type register_tag {i2c_register_tag::read};

constexpr explicit temperature_r(value_type v) noexcept
: basic_temperature_r {v} {}

constexpr explicit temperature_r() noexcept = default;
};

struct t_hyst_r : public basic_temperature_r<0x01> {
constexpr static i2c_tag_type register_tag {i2c_register_tag::read_write};

constexpr explicit t_hyst_r(value_type v) noexcept
: basic_temperature_r {v} {}

constexpr explicit t_hyst_r() noexcept
: basic_temperature_r {0b0100101100000000} {}
};

struct t_os_r : public basic_temperature_r<0x02> {
constexpr static i2c_tag_type register_tag {i2c_register_tag::read_write};

constexpr explicit t_os_r(value_type v) noexcept
: basic_temperature_r {v} {}

constexpr explicit t_os_r() noexcept
: basic_temperature_r {0b0101000000000000} {}
};

struct configuration_r : public simple_register<std::uint8_t, std::uint8_t, 0x00> {
constexpr static i2c_tag_type register_tag {i2c_register_tag::read_write};

const value_type reserved : 3 {};
value_type fault_queue : 2 {};
value_type os_polarity : 1 {};
value_type comparator : 1 {};
value_type shutdown : 1 {};

[[nodiscard]] constexpr auto get() const noexcept -> value_type override {
return static_cast<value_type>((fault_queue << 3) | (os_polarity << 2)
| (comparator << 1) | shutdown);
}

constexpr explicit configuration_r(value_type v) noexcept
: reserved {static_cast<value_type>((v & 0b11100000) >> 5)}
, fault_queue {static_cast<value_type>((v & 0b11000) >> 3)}
, os_polarity {static_cast<value_type>((v & 0b100) >> 2)}
, comparator {static_cast<value_type>((v & 0b10) >> 1)}
, shutdown {static_cast<value_type>(v & 0b1)} {}

constexpr explicit configuration_r() noexcept = default;
};
};

} // namespace muonpi::serial::devices

#endif
50 changes: 50 additions & 0 deletions src/serial/i2cdevices/lm75.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
#include "muonpi/serial/i2cdevices/lm75.h"

namespace muonpi::serial::devices {

lm75::lm75(traffic_t& bus_traffic, const std::string& path, i2c_device::address_type address)
: i2c_device {bus_traffic, path, address} {}

lm75::lm75(traffic_t& bus_traffic, const std::string& path)
: i2c_device {bus_traffic, path, addresses} {}

auto lm75::identify() -> bool {
if (flag_set(Flags::Error)) {
return false;
}
if (!present()) {
return false;
}

const auto config {read<configuration_r>()};
if (!config.has_value()) {
return false;
}
if (config.value().reserved != 0) {
return false;
}
const auto temp {read<temperature_r>()};
if (!temp.has_value()) {
return false;
}
if (temp.value().reserved != 0) {
return false;
}
const auto thyst {read<t_hyst_r>()};
if (!thyst.has_value()) {
return false;
}
if (thyst.value().reserved != 0) {
return false;
}
const auto tos {read<t_os_r>()};
if (!tos.has_value()) {
return false;
}
if (tos.value().reserved != 0) {
return false;
}

return true;
}
} // namespace muonpi::serial::devices