BoardPort.java

/*
 * This file is part of Arduino.
 *
 * Arduino is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * As a special exception, you may use this file as part of a free software
 * library without restriction.  Specifically, if other files instantiate
 * templates or use macros or inline functions from this file, or you compile
 * this file and link it with other files to produce an executable, this
 * file does not by itself cause the resulting executable to be covered by
 * the GNU General Public License.  This exception does not however
 * invalidate any other reasons why the executable file might be covered by
 * the GNU General Public License.
 *
 * Copyright 2013 Arduino LLC (http://www.arduino.cc/)
 */

package cc.arduino.packages;

import processing.app.BaseNoGui;
import processing.app.debug.TargetBoard;
import processing.app.debug.TargetPackage;
import processing.app.debug.TargetPlatform;
import processing.app.helpers.PreferencesMap;

public class BoardPort {

  private String address;   // unique name for this port, used by Preferences
  private String protocol;  // how to communicate, used for Ports menu sections
  private String protocolLabel; // protocol extended name to display on GUI
  private String boardName;
  private String label;     // friendly name shown in Ports menu
  private final PreferencesMap identificationPrefs; // data to match with boards.txt
  private final PreferencesMap prefs; // "vendorId", "productId", "serialNumber"
  private boolean online;   // used by SerialBoardsLister (during upload??)

  public BoardPort() {
    this.prefs = new PreferencesMap();
    this.identificationPrefs = new PreferencesMap();
  }

  public BoardPort(BoardPort bp) {
    prefs = new PreferencesMap(bp.prefs);
    identificationPrefs = new PreferencesMap(bp.identificationPrefs);
    address = bp.address;
    protocol = bp.protocol;
    boardName = bp.boardName;
    label = bp.label;
    online = bp.online;
  }

  public String getAddress() {
    return address;
  }

  public void setAddress(String address) {
    this.address = address;
  }

  public String getProtocol() {
    return protocol;
  }

  public void setProtocol(String protocol) {
    this.protocol = protocol;
  }

  public String getProtocolLabel() {
    return protocolLabel;
  }

  public void setProtocolLabel(String protocolLabel) {
    this.protocolLabel = protocolLabel;
  }

  public String getBoardName() {
    return boardName;
  }

  public void setBoardName(String boardName) {
    this.boardName = boardName;
  }

  public PreferencesMap getPrefs() {
    return prefs;
  }

  public PreferencesMap getIdentificationPrefs() {
    return identificationPrefs;
  }

  public void setLabel(String label) {
    this.label = label;
  }

  public String getLabel() {
    return label;
  }

  public void setOnlineStatus(boolean online) {
    this.online = online;
  }

  public boolean isOnline() {
    return online;
  }

  @Override
  public String toString() {
    return this.address;
  }

  // Search for the board which matches identificationPrefs.
  // If found, boardName is set to the name from boards.txt
  // and the board is returned.  If not found, null is returned.
  public TargetBoard searchMatchingBoard() {
    if (identificationPrefs == null || identificationPrefs.isEmpty()) return null;
    for (TargetPackage targetPackage : BaseNoGui.packages.values()) {
      for (TargetPlatform targetPlatform : targetPackage.getPlatforms().values()) {
        for (TargetBoard board : targetPlatform.getBoards().values()) {
          if (matchesBoard(board)) {
            setBoardName(board.getName());
            return board;
          }
        }
      }
    }
    return null;
  }

  public boolean matchesBoard(TargetBoard board) {
    PreferencesMap identificationProps = getIdentificationPrefs();
    PreferencesMap boardProps = board.getPreferences();

    String wildMatcher = identificationProps.get(".");
    if (wildMatcher != null) {
      if (wildMatcher.equals(board.getId())) {
        return true;
      }
      if (wildMatcher.equals(board.getFQBN())) {
        return true;
      }
    }

    // Identification properties are defined in boards.txt with a ".N" suffix
    // for example:
    //
    // uno.name=Arduino/Genuino Uno
    // uno.vid.0=0x2341
    // uno.pid.0=0x0043
    // uno.vid.1=0x2341
    // uno.pid.1=0x0001
    // uno.vid.2=0x2A03
    // uno.pid.2=0x0043
    // uno.vid.3=0x2341
    // uno.pid.3=0x0243
    //
    // so we must search starting from suffix ".0" and increasing until we
    // found a match or the board has no more identification properties defined

    for (int suffix = 0;; suffix++) {
      boolean found = true;
      for (String prop : identificationProps.keySet()) {
        String value = identificationProps.get(prop);
        prop += "." + suffix;
        if (!boardProps.containsKey(prop)) {
          return false;
        }
        if (!value.equalsIgnoreCase(boardProps.get(prop))) {
          found = false;
          break;
        }
      }
      if (found) {
        return true;
      }
    }
  }

}