github.com/arduino/arduino-cloud-cli@v0.0.0-20240517070944-e7a449561083/command/thing/thing.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 thing
    19  
    20  import (
    21  	"github.com/arduino/arduino-cloud-cli/command/tag"
    22  	iotclient "github.com/arduino/iot-client-go"
    23  )
    24  
    25  // ThingInfo contains the main parameters of
    26  // an Arduino IoT Cloud thing.
    27  type ThingInfo struct {
    28  	Name      string   `json:"name"`
    29  	ID        string   `json:"id"`
    30  	DeviceID  string   `json:"device_id"`
    31  	Variables []string `json:"variables"`
    32  	Tags      []string `json:"tags,omitempty"`
    33  }
    34  
    35  func getThingInfo(thing *iotclient.ArduinoThing) (*ThingInfo, error) {
    36  	// Process thing variables
    37  	var vars []string
    38  	for _, p := range thing.Properties {
    39  		vars = append(vars, p.Name)
    40  	}
    41  	// Process thing tags
    42  	tags, err := tag.TagsInfo(thing.Tags)
    43  	if err != nil {
    44  		return nil, err
    45  	}
    46  
    47  	info := &ThingInfo{
    48  		Name:      thing.Name,
    49  		ID:        thing.Id,
    50  		DeviceID:  thing.DeviceId,
    51  		Variables: vars,
    52  		Tags:      tags,
    53  	}
    54  	return info, nil
    55  }