1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107

/*
 * Copyright (C) 2018 Kubos Corporation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

use bitflags::bitflags;
use eps_api::{EpsError, EpsResult};
use rust_i2c::Command;

/// Board Status
///
/// The status bytes are designed to supply operational data about the I2C Node.
/// To retrieve the data that represents the status, the command 0x01 should be
/// sent followed by 0x00. The meaning of each bit of the returned status bytes
/// is shown below. Please note that Data[3] is the first byte returned from the
/// EPS and Data[0] is the last.

bitflags! {
    #[derive(Default)]
    pub struct StatusCode: u8 {
        const LAST_COMMAND_FAILED = 0b0000_0001;
        const WATCHDOG_ERROR = 0b0000_0010;
        const BAD_COMMAND_DATA = 0b0000_0100;
        const BAD_COMMAND_CHANNEL = 0b0000_1000;
        const ERROR_READING_EEPROM = 0b0001_0000;
        const POWER_ON_RESET = 0b0010_0000;
        const BROWN_OUT_RESET = 0b0100_0000;
    }
}

#[derive(Debug, Eq, PartialEq)]
pub struct BoardStatus {
    pub motherboard: StatusCode,
    pub daughterboard: Option<StatusCode>,
}

pub fn parse(data: &[u8]) -> EpsResult<BoardStatus> {
    if data.len() == 2 {
        Ok(BoardStatus {
            motherboard: StatusCode::from_bits(data[0]).unwrap_or_default(),
            daughterboard: None,
        })
    } else if data.len() == 4 {
        Ok(BoardStatus {
            motherboard: StatusCode::from_bits(data[2]).unwrap_or_default(),
            daughterboard: Some(StatusCode::from_bits(data[0]).unwrap_or_default()),
        })
    } else {
        Err(EpsError::parsing_failure("Board Status"))
    }
}

pub fn command() -> Command {
    Command {
        cmd: 0x01,
        data: vec![0x00],
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_parse_both_no_flags() {
        assert_eq!(
            BoardStatus {
                motherboard: StatusCode::default(),
                daughterboard: Some(StatusCode::default()),
            },
            parse(&vec![0x0, 0x0, 0x0, 0x0]).unwrap()
        )
    }

    #[test]
    fn test_parse_both() {
        assert_eq!(
            BoardStatus {
                motherboard: StatusCode::LAST_COMMAND_FAILED,
                daughterboard: Some(StatusCode::WATCHDOG_ERROR),
            },
            parse(&vec![0x2, 0x0, 0x1, 0x0]).unwrap()
        )
    }

    #[test]
    fn test_parse_motherboard() {
        assert_eq!(
            BoardStatus {
                motherboard: StatusCode::BAD_COMMAND_DATA,
                daughterboard: None,
            },
            parse(&vec![0x4, 0x0]).unwrap()
        )
    }
}