Device interface library for multiple platforms including Mbed.

Dependents:   DeepCover Embedded Security in IoT MaximInterface MAXREFDES155#

Maxim Interface is a library framework focused on providing flexible and expressive hardware interfaces. Both communication interfaces such as I2C and 1-Wire and device interfaces such as DS18B20 are supported. Modern C++ concepts are used extensively while keeping compatibility with C++98/C++03 and requiring no external dependencies. The embedded-friendly design does not depend on exceptions or RTTI.

The full version of the project is hosted on GitLab: https://gitlab.com/iabenz/MaximInterface

MaximInterfaceCore/LoggingOneWireMaster.cpp

Committer:
IanBenzMaxim
Date:
2019-09-16
Revision:
8:5ea891c7d1a1
Parent:
7:9cd16581b578

File content as of revision 8:5ea891c7d1a1:

/*******************************************************************************
* Copyright (C) Maxim Integrated Products, Inc., All Rights Reserved.
*
* 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 MAXIM INTEGRATED 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.
*
* Except as contained in this notice, the name of Maxim Integrated
* Products, Inc. shall not be used except as stated in the Maxim Integrated
* Products, Inc. Branding Policy.
*
* The mere transfer of this software does not imply any licenses
* of trade secrets, proprietary technology, copyrights, patents,
* trademarks, maskwork rights, or any other form of intellectual
* property whatsoever. Maxim Integrated Products, Inc. retains all
* ownership rights.
*******************************************************************************/

#include "HexString.hpp"
#include "LoggingOneWireMaster.hpp"

using std::string;

namespace MaximInterfaceCore {

static const char strongLevelString[] = "<SP_ON>";

static string formatDataString(span<const uint_least8_t> data, bool read) {
  string dataBuilder;
  for (span<const uint_least8_t>::index_type i = 0; i < data.size(); ++i) {
    if (read) {
      dataBuilder.append(1, '[');
    }
    dataBuilder.append(toHexString(data.subspan(i, 1)));
    if (read) {
      dataBuilder.append(1, ']');
    }
    dataBuilder.append(1, ' ');
  }
  return dataBuilder;
}

void LoggingOneWireMaster::tryWriteMessage(const std::string & message) {
  if (writeMessage) {
    writeMessage(message);
  }
}

Result<void> LoggingOneWireMaster::reset() {
  Result<void> result = OneWireMasterDecorator::reset();
  tryWriteMessage(result ? "RP" : "RN");
  return result;
}

Result<void> LoggingOneWireMaster::writeByteSetLevel(uint_least8_t sendByte,
                                                     Level afterLevel) {
  tryWriteMessage(formatDataString(make_span(&sendByte, 1), false));
  if (afterLevel == StrongLevel) {
    tryWriteMessage(strongLevelString);
  }
  return OneWireMasterDecorator::writeByteSetLevel(sendByte, afterLevel);
}

Result<uint_least8_t> LoggingOneWireMaster::readByteSetLevel(Level afterLevel) {
  const Result<uint_least8_t> recvByte =
      OneWireMasterDecorator::readByteSetLevel(afterLevel);
  if (recvByte) {
    tryWriteMessage(formatDataString(make_span(&recvByte.value(), 1), true));
    if (afterLevel == StrongLevel) {
      tryWriteMessage(strongLevelString);
    }
  }
  return recvByte;
}

Result<void>
LoggingOneWireMaster::writeBlock(span<const uint_least8_t> sendBuf) {
  tryWriteMessage(formatDataString(sendBuf, false));
  return OneWireMasterDecorator::writeBlock(sendBuf);
}

Result<void> LoggingOneWireMaster::readBlock(span<uint_least8_t> recvBuf) {
  Result<void> result = OneWireMasterDecorator::readBlock(recvBuf);
  if (result) {
    tryWriteMessage(formatDataString(recvBuf, true));
  }
  return result;
}

Result<void> LoggingOneWireMaster::setSpeed(Speed newSpeed) {
  Result<void> result = OneWireMasterDecorator::setSpeed(newSpeed);
  if (result) {
    string newSpeedString;
    switch (newSpeed) {
    case StandardSpeed:
      newSpeedString = "<STD>";
      break;

    case OverdriveSpeed:
      newSpeedString = "<OVR>";
      break;
    }
    if (!newSpeedString.empty()) {
      tryWriteMessage(newSpeedString);
    }
  }
  return result;
}

Result<void> LoggingOneWireMaster::setLevel(Level newLevel) {
  Result<void> result = OneWireMasterDecorator::setLevel(newLevel);
  if (result) {
    string newLevelString;
    switch (newLevel) {
    case NormalLevel:
      newLevelString = "<SP_OFF>";
      break;

    case StrongLevel:
      newLevelString = strongLevelString;
      break;
    }
    if (!newLevelString.empty()) {
      tryWriteMessage(newLevelString);
    }
  }
  return result;
}

} // namespace MaximInterfaceCore