---
title: "Update firmware"
canonical: "https://docs.cuesystem.com/space/CVCHELP/510591268/Update%20firmware"
format: markdown
---
> Macro (toc)

---

# CancelDownloadNewFirmware 

This function cancels downloading the new version of the firmware from the update server. 

#### Syntax 

```visualbasic
Function CancelDownloadNewFirmware () As Boolean
```

#### Return value 

<u>[Boolean](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean)</u> It is True on success or False if an error occurs. The function <u>[GetLastError](/wiki/spaces/CVCHELP/pages/510525445/Command+errors#GetLastError)</u> returns the error number.  

# GetDownloadNewFirmwareStatus 

This function returns the status of downloading a new firmware from the update server. The function <u>[GetLastError](/wiki/spaces/CVCHELP/pages/510525445/Command+errors#GetLastError)</u> returns the error number that occurred while executing the command.  

#### Syntax 

```visualbasic
Function GetDownloadNewFirmwareStatus( 
  ByRef status As Long, 
  ByRef percent As Double) 
As Boolean
```

#### Parameters 

status 

<u>[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long)</u> It is the current status of downloading. 

percent 

<u>[Double](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Double)</u> It is how many percent of the firmware is already downloaded. 

#### Return value 

<u>[Boolean](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean)</u> It is True on success or False if an error occurs. The function <u>[GetLastError](/wiki/spaces/CVCHELP/pages/510525445/Command+errors#GetLastError)</u> returns the error number. 

# IsNewFirmwareAvailable 

This function detects if a newer version of the firmware is available on the update server.  

#### Syntax 

```visualbasic
Function IsNewFirmwareAvailable (ByRef versionText As Text) As Boolean
```

#### Parameters 

versionText 

<u>[Text](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Text)</u> It is the destination text for the new firmware version. 

#### Return value 

<u>[Boolean](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean)</u> It is True if a new firmware is available or False if an error occurs or there is no new firmware on the update server. The function GetLastError returns the error number. 

# StartDownloadNewFirmware 

This function starts downloading the new firmware from the update server. 

#### Syntax 

```visualbasic
Function StartDownloadNewFirmware() As Boolean
```

#### Return value 

<u>[Boolean](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean)</u> It is True on success or False if an error occurs. The function <u>[GetLastError](/wiki/spaces/CVCHELP/pages/510525445/Command+errors#GetLastError)</u> returns the error number. 

# UpdateFirmware 

This function uses downloaded firmware and starts updating of the firmware in the device. When the firmware update is complete, the device is restarted automatically. 

#### Syntax 

```visualbasic
Function UpdateFirmware() As Boolean
```

#### Return value* *

<u>[Boolean](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean)</u> It is True on success or False if an error occurs. The function <u>[GetLastError](/wiki/spaces/CVCHELP/pages/510525445/Command+errors#GetLastError)</u> returns the error number.