github.com/arduino/arduino-cloud-cli@v0.0.0-20240517070944-e7a449561083/command/thing/bind.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  	"context"
    22  
    23  	"github.com/arduino/arduino-cloud-cli/config"
    24  
    25  	"github.com/arduino/arduino-cloud-cli/internal/iot"
    26  	iotclient "github.com/arduino/iot-client-go"
    27  )
    28  
    29  // BindParams contains the parameters needed to
    30  // bind a thing to a device.
    31  type BindParams struct {
    32  	ID       string // ID of the thing to be bound
    33  	DeviceID string // ID of the device to be bound
    34  }
    35  
    36  // Bind command is used to bind a thing to a device
    37  // on Arduino IoT Cloud.
    38  func Bind(ctx context.Context, params *BindParams, cred *config.Credentials) error {
    39  	iotClient, err := iot.NewClient(cred)
    40  	if err != nil {
    41  		return err
    42  	}
    43  
    44  	thing := &iotclient.ThingUpdate{
    45  		DeviceId: params.DeviceID,
    46  	}
    47  
    48  	err = iotClient.ThingUpdate(ctx, params.ID, thing, true)
    49  	if err != nil {
    50  		return err
    51  	}
    52  
    53  	return nil
    54  }