wasefire_board_api/led.rs
1// Copyright 2022 Google LLC
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15//! LED interface.
16//!
17//! A LED is an output interface with 2 states: on and off.
18
19use crate::{Error, Id, Support};
20
21/// LED interface.
22pub trait Api: Support<usize> + Send {
23 /// Returns whether a given LED is on.
24 fn get(led: Id<Self>) -> Result<bool, Error>;
25
26 /// Sets the state of a given LED.
27 fn set(led: Id<Self>, on: bool) -> Result<(), Error>;
28}