list.go

// This file is part of arduino-cloud-cli.
//
// Copyright (C) 2021 ARDUINO SA (http://www.arduino.cc/)
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published
// by the Free Software Foundation, either version 3 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 Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.

package device

import (
	"fmt"

	"github.com/arduino/arduino-cloud-cli/internal/config"
	"github.com/arduino/arduino-cloud-cli/internal/iot"
)

// ListParams contains the optional parameters needed
// to filter the devices to be listed.
type ListParams struct {
	Tags map[string]string // If tags are provided, only devices that have all these tags are listed.
}

// List command is used to list
// the devices of Arduino IoT Cloud.
func List(params *ListParams, cred *config.Credentials) ([]DeviceInfo, error) {
	iotClient, err := iot.NewClient(cred)
	if err != nil {
		return nil, err
	}

	foundDevices, err := iotClient.DeviceList(params.Tags)
	if err != nil {
		return nil, err
	}

	var devices []DeviceInfo
	for _, foundDev := range foundDevices {
		dev, err := getDeviceInfo(&foundDev)
		if err != nil {
			return nil, fmt.Errorf("parsing device %s from cloud: %w", foundDev.Id, err)
		}
		devices = append(devices, *dev)
	}

	return devices, nil
}