wd-fw-update


Namewd-fw-update JSON
Version 2.0.1 PyPI version JSON
download
home_pagehttps://github.com/not-a-feature/wd_fw_update
SummaryUpdates the firmware of Western Digital SSDs on Ubuntu / Linux Mint.
upload_time2024-11-06 19:55:06
maintainerNone
docs_urlNone
authorJules Kreuer
requires_pythonNone
licenseGPL-3.0-or-later
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            [![ReadTheDocs](https://readthedocs.org/projects/wd_fw_update/badge/?version=latest)](https://wd-fw-update.readthedocs.io/en/stable/)
[![PyPI-Server](https://img.shields.io/pypi/v/wd_fw_update.svg)](https://pypi.org/project/wd_fw_update/)
[![Monthly Downloads](https://pepy.tech/badge/wd_fw_update/month)](https://pepy.tech/project/wd_fw_update)

# wd_fw_update
<img alt="Western Digital SSD Firmware Update Tool" src=https://github.com/not-a-feature/wd_fw_update/raw/main/logo.png height=90>

This is a firmware update tool for Western Digital SSDs on Ubuntu / Linux Mint.

It provides a user-friendly interface to select the firmware version for the update process.

It uses the Western Digital API and the NVME toolbox `nvme-cli` but is NOT associated in any case to them.

It was originally developed for Frame.Work laptops, but should work with any Ubuntu / Mint device with Western Digital NVME SSD.

See the discussion on: [community.frame.work](https://community.frame.work/t/western-digital-drive-update-guide-without-windows-wd-dashboard/20616) and [juleskreuer.eu](https://juleskreuer.eu/western-digital-firmware-update/)

<img alt="GIF" src=https://github.com/not-a-feature/wd_fw_update/raw/main/gif.gif height=250>

## Installation
### Prerequisites

Make sure the following dependencies are installed on your system:
- sudo
- nvme-cli

### Via source

Clone the repository:

```bash
git clone https://github.com/not-a-feature/wd_fw_update.git
cd wd_fw_update

pip install .
```

### Via pypi:
The newest release is published on pypi.

```bash
pip install wd-fw-update
```


## Usage

Run

```bash
wd_fw_update
```

Follow the on-screen prompts to select the appropriate options for your firmware update.
The script will guide you through the process, and once completed, it will provide a summary of the update.
Depending on the update mode, it may prompt you to reboot or switch to the new slot.


## Command-Line Options

    --version: Display the version of the firmware update tool.
    -i, --info: Display information about the available drives.
    -v, --verbose: Set the log level to INFO.
    -vv, --very-verbose: Set the log level to DEBUG.

The -i flag will display about the available drives.

Example:

```
========== Device Info ==========
Device                   : /dev/nvme0n1
Model                    : WD_BLACK SN770 500GB
Current fw version       : 731120WD
Slot 1 readonly          : False
Slot count               : 2
Current slot             : 2
Slots with firmware      : {1: '731030WD', 2: '731120WD'}
```

## Note

This project has been set up using PyScaffold 4.5. For details and usage
information on PyScaffold see https://pyscaffold.org/.

## Dependencies
- [nvme cli](https://github.com/linux-nvme/nvme-cli)
- [inquirer](https://pypi.org/project/inquirer/)
- [tqdm](https://pypi.org/project/tqdm/)
- [requests](https://pypi.org/project/requests/)

## License
Copyright (C) 2024 by Jules Kreuer - @not_a_feature
This piece of software is published unter the GNU General Public License v3.0
TLDR:

 | Permissions      | Conditions                   | Limitations |
 | ---------------- | ---------------------------- | ----------- |
 | ✓ Commercial use | Disclose source              | ✕ Liability |
 | ✓ Distribution   | License and copyright notice | ✕ Warranty  |
 | ✓ Modification   | Same license                 |             |
 | ✓ Patent use     | State changes                |             |
 | ✓ Private use    |                              |             |

Go to [LICENSE](https://github.com/not-a-feature/wd_fw_update/blob/main/LICENSE) to see the full version.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/not-a-feature/wd_fw_update",
    "name": "wd-fw-update",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": null,
    "author": "Jules Kreuer",
    "author_email": "contact@juleskreuer.eu",
    "download_url": "https://files.pythonhosted.org/packages/d8/dd/bf558c70917a71c6a7f1adcedb3a88e45ec3f7676b399c5c424192f58de2/wd_fw_update-2.0.1.tar.gz",
    "platform": "Mac",
    "description": "[![ReadTheDocs](https://readthedocs.org/projects/wd_fw_update/badge/?version=latest)](https://wd-fw-update.readthedocs.io/en/stable/)\n[![PyPI-Server](https://img.shields.io/pypi/v/wd_fw_update.svg)](https://pypi.org/project/wd_fw_update/)\n[![Monthly Downloads](https://pepy.tech/badge/wd_fw_update/month)](https://pepy.tech/project/wd_fw_update)\n\n# wd_fw_update\n<img alt=\"Western Digital SSD Firmware Update Tool\" src=https://github.com/not-a-feature/wd_fw_update/raw/main/logo.png height=90>\n\nThis is a firmware update tool for Western Digital SSDs on Ubuntu / Linux Mint.\n\nIt provides a user-friendly interface to select the firmware version for the update process.\n\nIt uses the Western Digital API and the NVME toolbox `nvme-cli` but is NOT associated in any case to them.\n\nIt was originally developed for Frame.Work laptops, but should work with any Ubuntu / Mint device with Western Digital NVME SSD.\n\nSee the discussion on: [community.frame.work](https://community.frame.work/t/western-digital-drive-update-guide-without-windows-wd-dashboard/20616) and [juleskreuer.eu](https://juleskreuer.eu/western-digital-firmware-update/)\n\n<img alt=\"GIF\" src=https://github.com/not-a-feature/wd_fw_update/raw/main/gif.gif height=250>\n\n## Installation\n### Prerequisites\n\nMake sure the following dependencies are installed on your system:\n- sudo\n- nvme-cli\n\n### Via source\n\nClone the repository:\n\n```bash\ngit clone https://github.com/not-a-feature/wd_fw_update.git\ncd wd_fw_update\n\npip install .\n```\n\n### Via pypi:\nThe newest release is published on pypi.\n\n```bash\npip install wd-fw-update\n```\n\n\n## Usage\n\nRun\n\n```bash\nwd_fw_update\n```\n\nFollow the on-screen prompts to select the appropriate options for your firmware update.\nThe script will guide you through the process, and once completed, it will provide a summary of the update.\nDepending on the update mode, it may prompt you to reboot or switch to the new slot.\n\n\n## Command-Line Options\n\n    --version: Display the version of the firmware update tool.\n    -i, --info: Display information about the available drives.\n    -v, --verbose: Set the log level to INFO.\n    -vv, --very-verbose: Set the log level to DEBUG.\n\nThe -i flag will display about the available drives.\n\nExample:\n\n```\n========== Device Info ==========\nDevice                   : /dev/nvme0n1\nModel                    : WD_BLACK SN770 500GB\nCurrent fw version       : 731120WD\nSlot 1 readonly          : False\nSlot count               : 2\nCurrent slot             : 2\nSlots with firmware      : {1: '731030WD', 2: '731120WD'}\n```\n\n## Note\n\nThis project has been set up using PyScaffold 4.5. For details and usage\ninformation on PyScaffold see https://pyscaffold.org/.\n\n## Dependencies\n- [nvme cli](https://github.com/linux-nvme/nvme-cli)\n- [inquirer](https://pypi.org/project/inquirer/)\n- [tqdm](https://pypi.org/project/tqdm/)\n- [requests](https://pypi.org/project/requests/)\n\n## License\nCopyright (C) 2024 by Jules Kreuer - @not_a_feature\nThis piece of software is published unter the GNU General Public License v3.0\nTLDR:\n\n | Permissions      | Conditions                   | Limitations |\n | ---------------- | ---------------------------- | ----------- |\n | \u2713 Commercial use | Disclose source              | \u2715 Liability |\n | \u2713 Distribution   | License and copyright notice | \u2715 Warranty  |\n | \u2713 Modification   | Same license                 |             |\n | \u2713 Patent use     | State changes                |             |\n | \u2713 Private use    |                              |             |\n\nGo to [LICENSE](https://github.com/not-a-feature/wd_fw_update/blob/main/LICENSE) to see the full version.\n",
    "bugtrack_url": null,
    "license": "GPL-3.0-or-later",
    "summary": "Updates the firmware of Western Digital SSDs on Ubuntu / Linux Mint.",
    "version": "2.0.1",
    "project_urls": {
        "Changelog": "https://github.com/not-a-feature/wd_fw_update/releases",
        "Documentation": "https://github.com/not-a-feature/wd_fw_update",
        "Download": "https://pypi.org/project/wd_fw_update/",
        "Homepage": "https://github.com/not-a-feature/wd_fw_update",
        "Source": "https://github.com/not-a-feature/wd_fw_update",
        "Tracker": "https://github.com/not-a-feature/wd_fw_update/issues"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "20e9faf4cdec88c807f9a9d70abe39cbc976bc661d81c9a595e6e8d2dac5bb09",
                "md5": "44fef3c46238ed11ba07ce2bd35351c8",
                "sha256": "292e2743505a38e2449814157b5d373f0e304dba4835af4956392a39748f4abd"
            },
            "downloads": -1,
            "filename": "wd_fw_update-2.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "44fef3c46238ed11ba07ce2bd35351c8",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 9128,
            "upload_time": "2024-11-06T19:55:05",
            "upload_time_iso_8601": "2024-11-06T19:55:05.407878Z",
            "url": "https://files.pythonhosted.org/packages/20/e9/faf4cdec88c807f9a9d70abe39cbc976bc661d81c9a595e6e8d2dac5bb09/wd_fw_update-2.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d8ddbf558c70917a71c6a7f1adcedb3a88e45ec3f7676b399c5c424192f58de2",
                "md5": "017342931ddaf3f248bd3e8985e30aa8",
                "sha256": "e1886c77f0cb6314ee58dbc8eaccea755ff8dea6899e05941b94cc97abf0ebff"
            },
            "downloads": -1,
            "filename": "wd_fw_update-2.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "017342931ddaf3f248bd3e8985e30aa8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 325610,
            "upload_time": "2024-11-06T19:55:06",
            "upload_time_iso_8601": "2024-11-06T19:55:06.738059Z",
            "url": "https://files.pythonhosted.org/packages/d8/dd/bf558c70917a71c6a7f1adcedb3a88e45ec3f7676b399c5c424192f58de2/wd_fw_update-2.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-06 19:55:06",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "not-a-feature",
    "github_project": "wd_fw_update",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "lcname": "wd-fw-update"
}
        
Elapsed time: 1.34075s