SatNOGS-COMMS  4.1.0
A COMMS subsystem for CubeSats
Loading...
Searching...
No Matches
leds.hpp
Go to the documentation of this file.
1/*
2 * SatNOGS-COMMS control library
3 *
4 * Copyright (C) 2022, Libre Space Foundation <http://libre.space>
5 *
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 *
19 * SPDX-License-Identifier: GNU General Public License v3.0 or later
20 */
21
22#pragma once
23
24#include <cstdint>
25#include <etl/flat_map.h>
27namespace satnogs::comms::lib
28{
38class leds
39{
40public:
44 enum class led : uint8_t
45 {
48 };
49
51
52 void
53 toggle(led x);
54
55 void
56 enable(led x, bool en = true);
57
58 void
59 disable(led x);
60
61 bool
62 enabled(led x) const;
63
64private:
65 etl::flat_map<led, bsp::gpio &, 2> m_leds;
66};
67
68} // namespace satnogs::comms::lib
GPIO device abstraction.
Definition gpio.hpp:38
void disable(led x)
Disables the specified led.
Definition leds.cpp:76
bool enabled(led x) const
Checks if the specified led is currently enabled.
Definition leds.cpp:88
void toggle(led x)
Toggles the state of the specified LED.
Definition leds.cpp:47
leds(bsp::gpio &led0, bsp::gpio &led1)
Constructs an instance of the leds class.
Definition leds.cpp:34
void enable(led x, bool en=true)
Enables or disables the specified led.
Definition leds.cpp:62
led
Enumerates the available LEDs on the SatNOGS-COMMS board.
Definition leds.hpp:45
const struct gpio_dt_spec led1
Definition startup.cpp:21
const struct gpio_dt_spec led0
Definition startup.cpp:20