Added device filter support

Author: rjtokenring

cli/device/list.go

@@ -33,7 +33,8 @@ import (
 )
 
 type listFlags struct {
-	tags map[string]string
+	tags      map[string]string
+	deviceIds string
 }
 
 func initListCommand() *cobra.Command {
@@ -56,6 +57,7 @@ func initListCommand() *cobra.Command {
 		"Comma-separated list of tags with format <key>=<value>.\n"+
 			"List only devices that match the provided tags.",
 	)
+	listCommand.Flags().StringVarP(&flags.deviceIds, "device-ids", "d", "", "Comma separated list of Device IDs")
 	return listCommand
 }
 
@@ -67,7 +69,7 @@ func runListCommand(flags *listFlags) error {
 		return fmt.Errorf("retrieving credentials: %w", err)
 	}
 
-	params := &device.ListParams{Tags: flags.tags}
+	params := &device.ListParams{Tags: flags.tags, DeviceIds: flags.deviceIds}
 	devs, err := device.List(context.TODO(), params, cred)
 	if err != nil {
 		return err

command/device/list.go

@@ -20,6 +20,8 @@ package device
 import (
 	"context"
 	"fmt"
+	"slices"
+	"strings"
 
 	"github.com/arduino/arduino-cloud-cli/config"
 	"github.com/arduino/arduino-cloud-cli/internal/iot"
@@ -28,7 +30,8 @@ import (
 // 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.
+	Tags      map[string]string // If tags are provided, only devices that have all these tags are listed.
+	DeviceIds string            // If ids are provided, only devices with these ids are listed.
 }
 
 // List command is used to list
@@ -43,9 +46,19 @@ func List(ctx context.Context, params *ListParams, cred *config.Credentials) ([]
 	if err != nil {
 		return nil, err
 	}
+	var deviceIdFilter []string
+	if params.DeviceIds != "" {
+		deviceIdFilter = strings.Split(params.DeviceIds, ",")
+		for i := range deviceIdFilter {
+			deviceIdFilter[i] = strings.TrimSpace(deviceIdFilter[i])
+		}
+	}
 
 	var devices []DeviceInfo
 	for _, foundDev := range foundDevices {
+		if len(deviceIdFilter) > 0 && !slices.Contains(deviceIdFilter, foundDev.Id) {
+			continue
+		}
 		dev, err := getDeviceInfo(&foundDev)
 		if err != nil {
 			return nil, fmt.Errorf("parsing device %s from cloud: %w", foundDev.Id, err)

example/tools/ota/ota_mass_upload.sh

@@ -12,6 +12,21 @@ checkExecutable () {
     fi
 }
 
+printHelp () {
+    echo ""
+    echo "Usage: $0 [-t <tag> | -d <device ids>] -f <firmwarefile> [-o <waittime in seconds - default 600>] [-v <new firmware version for tagging updated devices>]"
+    echo ""
+    echo "Examples -----------------"
+    echo "  perform ota on devices with firmware=v1 tag"
+    echo "    $0 -t firmware=v1 -f myfirmware.bin"
+    echo "  perform ota on devices with firmware=v1 tag and apply new tag firmware=v2 to updated devices, waiting for 1200 seconds"
+    echo "    $0 -t firmware=v1 -f myfirmware.bin -v firmware=v2 -w 1200"
+    echo "  perform ota on two specified devices"
+    echo "    $0 -d 261ec96a-38ba-4520-96e6-2447c4163e9b,8b10acdb-b722-4068-8e4d-d1c1b7302df4 -f myfirmware.bin"    
+    echo ""
+    exit 1
+}
+
 # Check dependencies...
 checkExecutable "arduino-cloud-cli"
 checkExecutable "jq"
@@ -23,33 +38,48 @@ checkExecutable "paste"
 waittime=600
 newtagversion=""
 
-while getopts t:v:f:o: flag
+while getopts t:v:f:o:d: flag
 do
     case "${flag}" in
         t) tag=${OPTARG};;
         v) newtagversion=${OPTARG};;
         f) firmwarefile=${OPTARG};;
         o) waittime=${OPTARG};;
+        d) deviceids=${OPTARG};;
     esac
 done
 
-if [[ "$firmwarefile" == "" || "$tag" == "" || "$waittime" == "" ]]; then
-    echo "Usage: $0 -t <tag> -f <firmwarefile> [-o <waittime>] [-v <new firmware version for tagging>]"
-    exit 1    
+if [[ "$firmwarefile" == "" || "$waittime" == "" ]]; then
+    printHelp    
+fi
+if [[ "$tag" == "" && "$deviceids" == "" ]]; then
+    printHelp    
 fi
 
-echo "Starting OTA process for devices with tag \"$tag\" using firmware \"$firmwarefile\""
-echo ""
+if [[ "$deviceids" == "" ]]; then
+    echo "Starting OTA process for devices with tag \"$tag\" using firmware \"$firmwarefile\""
+    echo ""
+
+    devicelistjson=$(arduino-cloud-cli device list --tags $tag --format json)
+else
+    echo "Starting OTA process for devices \"$deviceids\" using firmware \"$firmwarefile\""
+    echo ""
+
+    devicelistjson=$(arduino-cloud-cli device list -d $deviceids --format json)
+fi
 
-devicelistjson=$(arduino-cloud-cli device list --tags $tag --format json)
 devicecount=$(echo $devicelistjson | jq '.[] | .id' | wc -l)
 
 if [ "$devicecount" -gt 0 ]; then
-    echo "Found $devicecount devices with tag \"$tag\""
+    echo "Found $devicecount devices"
     echo ""
-    arduino-cloud-cli device list --tags $tag
+    if [[ "$deviceids" == "" ]]; then
+        arduino-cloud-cli device list --tags $tag
+    else
+        arduino-cloud-cli device list -d $deviceids
+    fi
 else 
-    echo "No devices found with tag \"$tag\""
+    echo "No device found"
     exit 1    
 fi
 
@@ -66,7 +96,11 @@ fi
 fqbn=$(echo $devicelistjson | jq -r '.[] | .fqbn' | sort | uniq | head -n 1)
 
 echo "Sending OTA request to detected boards of type $fqbn..."
-otastartedout=$(arduino-cloud-cli ota mass-upload --device-tags $tag --file $firmwarefile -b $fqbn --format json)
+if [[ "$deviceids" == "" ]]; then
+    otastartedout=$(arduino-cloud-cli ota mass-upload --device-tags $tag --file $firmwarefile -b $fqbn --format json)
+else
+    otastartedout=$(arduino-cloud-cli ota mass-upload -d $deviceids --file $firmwarefile -b $fqbn --format json)
+fi
 if [ $? -ne 0 ]; then
     echo "Detected error during OTA process. Exiting..."
     exit 1