github.com/arduino/arduino-cloud-cli@v0.0.0-20240517070944-e7a449561083/command/device/device.go (about)

     1  // This file is part of arduino-cloud-cli.
     2  //
     3  // Copyright (C) 2021 ARDUINO SA (http://www.arduino.cc/)
     4  //
     5  // This program is free software: you can redistribute it and/or modify
     6  // it under the terms of the GNU Affero General Public License as published
     7  // by the Free Software Foundation, either version 3 of the License, or
     8  // (at your option) any later version.
     9  //
    10  // This program is distributed in the hope that it will be useful,
    11  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    12  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    13  // GNU Affero General Public License for more details.
    14  //
    15  // You should have received a copy of the GNU Affero General Public License
    16  // along with this program.  If not, see <https://www.gnu.org/licenses/>.
    17  
    18  package device
    19  
    20  import (
    21  	"github.com/arduino/arduino-cloud-cli/command/tag"
    22  	iotclient "github.com/arduino/iot-client-go"
    23  )
    24  
    25  // DeviceInfo contains the most interesting
    26  // parameters of an Arduino IoT Cloud device.
    27  type DeviceInfo struct {
    28  	Name   string   `json:"name"`
    29  	ID     string   `json:"id"`
    30  	Board  string   `json:"board"`
    31  	Serial string   `json:"serial_number"`
    32  	FQBN   string   `json:"fqbn"`
    33  	Tags   []string `json:"tags,omitempty"`
    34  }
    35  
    36  func getDeviceInfo(device *iotclient.ArduinoDevicev2) (*DeviceInfo, error) {
    37  	// Retrieve device tags
    38  	tags, err := tag.TagsInfo(device.Tags)
    39  	if err != nil {
    40  		return nil, err
    41  	}
    42  
    43  	dev := &DeviceInfo{
    44  		Name:   device.Name,
    45  		ID:     device.Id,
    46  		Board:  device.Type,
    47  		Serial: device.Serial,
    48  		FQBN:   device.Fqbn,
    49  		Tags:   tags,
    50  	}
    51  	return dev, nil
    52  }