github.com/arduino/arduino-cloud-cli@v0.0.0-20240517070944-e7a449561083/command/device/listfrequency.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  	"context"
    22  	"fmt"
    23  
    24  	"github.com/arduino/arduino-cloud-cli/config"
    25  	"github.com/arduino/arduino-cloud-cli/internal/iot"
    26  )
    27  
    28  // FrequencyPlanInfo describes a LoRa frequency plan.
    29  type FrequencyPlanInfo struct {
    30  	Name     string `json:"name"`
    31  	ID       string `json:"id"`
    32  	Advanced string `json:"advanced"`
    33  }
    34  
    35  // ListFrequencyPlans command is used to list
    36  // the supported LoRa frequency plans.
    37  func ListFrequencyPlans(ctx context.Context, cred *config.Credentials) ([]FrequencyPlanInfo, error) {
    38  	iotClient, err := iot.NewClient(cred)
    39  	if err != nil {
    40  		return nil, err
    41  	}
    42  
    43  	foundFreqs, err := iotClient.LoraFrequencyPlansList(ctx)
    44  	if err != nil {
    45  		return nil, err
    46  	}
    47  
    48  	freqs := make([]FrequencyPlanInfo, 0, len(foundFreqs))
    49  	for _, f := range foundFreqs {
    50  		freq := FrequencyPlanInfo{
    51  			Name:     f.Name,
    52  			ID:       f.Id,
    53  			Advanced: fmt.Sprintf("%v", f.Advanced),
    54  		}
    55  		freqs = append(freqs, freq)
    56  	}
    57  
    58  	return freqs, nil
    59  }