upload-ota-payload

Description

Upload a binary to be used for an OTA update.

    See https://mflt.io/34PyNGQ for details about 'hardware-version',
    'software-type' and 'software-version' nomenclature.

    When deployed, this is the binary that will be returned from the Memfault /latest endpoint
    which can be used for an Over The Air (OTA) update.

    
    Example OTA Upload:
    
        $ memfault --org-token $ORG_TOKEN \
                   --org acme-inc --project smart-sink \
            upload-ota-payload \
            --hardware-version mp \
            --software-type stm32-fw \
            --software-version 1.0.0-alpha \
            --revision 89335ffade90ff7697e2ce5238bd4c68978b6d6e \
            build/stm32-fw.bin

    
    Example Delta OTA Upload:
    
        $ memfault --org-token $ORG_TOKEN \
                   --org acme-inc --project smart-sink \
            upload-ota-payload \
            --hardware-version mp \
            --software-type stm32-fw \
            --delta-from 0.9.0 \
            --delta-to 1.0.0-alpha \
            --revision 89335ffade90ff7697e2ce5238bd4c68978b6d6e \
            build/stm32-fw-delta.bin

    Reference: https://mflt.io/create-release

Arguments

Argument	Type	Required
path	Path	True

Options

Option	Short	Required	Default	Description
--hardware-version	None	True	None	None
--software-type	None	True	None	None
--software-version	None	False	None	Make the OTA Payload a Full Release payload for this version.
--delta-from	None	False	None	Pass --delta-from FROM_VERSION make the OTA Payload a Delta Release payload from the version FROM_VERSION. Use alongside --delta-to TO_VERSION
--delta-to	None	False	None	Pass --delta-to TO_VERSION to make the OTA Payload a Delta Release payload to version TO_VERSION. Use alongside --delta-from FROM_VERSION.
--notes	None	False		Optional release notes.
--must-pass-through	None	False	False	When the Release is deployed to a Cohort, forces a device to update through this version even if a newer version has also been deployed to the Cohort.
--extra-metadata	None	False	None	Extra metadata in the form of <key>=<value> to attach to this artifact. This metadata will be returned alongside the artifact when the release is fetched.
--revision	None	False	None	Revision SHA or # (git, SVN, etc.)
--help	None	False	False	Show this message and exit.