github.com/arduino/arduino-cloud-cli@v0.0.0-20240517070944-e7a449561083/command/ota/encode.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 ota
    19  
    20  import (
    21  	"fmt"
    22  	"os"
    23  	"strings"
    24  
    25  	"github.com/arduino/arduino-cloud-cli/internal/ota"
    26  )
    27  
    28  type EncodeParams struct {
    29  	FQBN string
    30  	File string
    31  }
    32  
    33  // Encode command is used to encode a firmware OTA
    34  func Encode(params *EncodeParams) (*string, error) {
    35  	_, err := os.Stat(params.File)
    36  	if err != nil {
    37  		return nil, fmt.Errorf("file %s does not exists: %w", params.File, err)
    38  	}
    39  
    40  	// Verify if file has already an OTA header
    41  	header, _ := ota.DecodeOtaFirmwareHeaderFromFile(params.File)
    42  	if header != nil {
    43  		return nil, fmt.Errorf("file %s contains a valid OTA header. Skip header encoding", params.File)
    44  	}
    45  
    46  	var otaFile string
    47  	if strings.HasSuffix(params.File, ".bin") {
    48  		otaFile = strings.Replace(params.File, ".bin", ".ota", 1)
    49  	} else {
    50  		otaFile = fmt.Sprintf("%s.ota", params.File)
    51  	}
    52  	_, err = os.Stat(otaFile)
    53  	if err == nil {
    54  		// file already exists, we need to delete it
    55  		if err = os.Remove(otaFile); err != nil {
    56  			return nil, fmt.Errorf("%s: %w", "cannot remove .ota file", err)
    57  		}
    58  	}
    59  
    60  	err = Generate(params.File, otaFile, params.FQBN)
    61  	if err != nil {
    62  		return nil, fmt.Errorf("%s: %w", "cannot generate .ota file", err)
    63  	}
    64  
    65  	return &otaFile, nil
    66  }