Skip to content

Latest commit

 

History

History
586 lines (263 loc) · 26.7 KB

CHANGELOG.md

File metadata and controls

586 lines (263 loc) · 26.7 KB
Raw

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

7.1.1 (2024-11-14)

Bug Fixes

  • simplify firmware versions (1b94c63)

7.1.0 (2024-11-14)

Bug Fixes

Features

  • additional studio firmware versions (46c49d7)
  • additional studio firmware versions (usb) (4e2e5df)

7.0.2 (2024-09-16)

Bug Fixes

  • ensure error handler is added while probing a tcp socket (14e7765)

7.0.1 (2024-09-10)

Bug Fixes

  • disable SUPPORTS_RGB_KEY_FILL for some models #101 (d752b41)

7.0.0 (2024-09-08)

Features

7.0.0-0 (2024-08-26)

Features

  • target nodejs 18 (5fe6c09)
  • rework how device functionality is exposed
  • rework events structure

6.2.2 (2024-07-11)

Bug Fixes

6.2.1 (2024-07-11)

Bug Fixes

6.2.0 (2024-04-30)

Bug Fixes

  • clear neo screen as part of clearPanel (53b88e5)
  • omit tests from npm packages (80e6676)
  • rework udev rules #88 (d6054a7)
  • support longer serial numbers #76 (545cb6e)
  • update examples to run and better support plus and neo (219e37c)

Features

  • add KEY_SPACING_VERTICAL and KEY_SPACING_HORIZONTAL properties (d69e5c7)
  • neo lcd drawing (7d13bc0)
  • node: expose path of opened device #65 (45ebbe5)
  • refactor image generation to be more modular (4f62a9d)
  • refactor streamdeck plus lcd image generation (needs testing) (e32eaa5)
  • support for streamdeck neo (65197a7)
  • webhid: Add forget method #79 (f13ee36)

6.1.0 (2024-04-21)

Bug Fixes

Features

  • add KEY_SPACING_VERTICAL and KEY_SPACING_HORIZONTAL properties (d69e5c7)
  • node: expose path of opened device #65 (45ebbe5)
  • webhid: Add forget method #79 (f13ee36)

6.0.0 (2023-11-29)

Features

5.7.3 (2023-06-20)

Bug Fixes

  • streamdeck mini unable to be opened on windows (f8b174a)

5.7.2 (2023-01-17)

Bug Fixes

  • node: avoid duplicates in listStreamDecks #32 (660eb39)

5.7.1 (2023-01-17)

Bug Fixes

  • webhid: Ignore hid devices which are non-streamdeck #60 (b212d4e)

5.7.0 (2022-11-15)

Features

Reverts

  • Revert "chore: switch to yarn3" (45f6137)

5.6.0 (2022-09-30)

Note: Version bump only for package elgato-stream-deck-packages

5.6.0-alpha.0 (2022-09-25)

Note: Version bump only for package elgato-stream-deck-packages

5.5.0 (2022-07-25)

Note: Version bump only for package elgato-stream-deck-packages

5.5.0-alpha.1 (2022-07-25)

Bug Fixes

5.5.0-alpha.0 (2022-07-08)

Bug Fixes

  • optimise coordinate manipulation for buffers (4ca3b66)
  • support @julusian/jpeg-turbo 2.x (9a0a718)

Features

5.4.0 (2022-05-10)

Bug Fixes

  • add missing tslib dependency (6b53699)
  • UDEV rules example markdown. Missing * after hidraw (#43) (596b1f9)
  • UDEV rules example markdown. Missing * after hidraw (#43) (6f94093)

5.4.0-alpha.0 (2022-04-12)

Features

  • support for the pedal (untested) (ccc4389)

5.3.1 (2022-02-21)

Bug Fixes

  • ensure build before publish (786ad79)

5.3.0 (2022-02-21)

Features

  • allow the original 15 key to be used in webhid (7ff5624)
  • use hidraw backend on linux, as modern (2 year old) kernels support it for all models now (596e426)

5.2.0 (2022-01-25)

Note: Version bump only for package elgato-stream-deck-packages

5.2.0-alpha.1 (2022-01-19)

Note: Version bump only for package elgato-stream-deck-packages

5.2.0-alpha.0 (2022-01-18)

Features

  • add method to get info about a hid device, if it is a streamdeck (1791e37)
  • add PRODUCT_NAME property (fbe3d14)

5.1.2 (2021-12-02)

Bug Fixes

  • fillPanelBuffer not waiting for write #28 (020a047)

5.1.1 (2021-07-19)

Bug Fixes

5.1.0 (2021-07-19)

Features

  • support streamdeck mk2 (15 key, new style) (a239503)

5.0.0 (2021-03-07)

This is a major overhaul of the library to allow for support for webhid to be added cleanly. The major changes are listed below, and should be reviewed when updating.

The most notable changes are the api now returns promises for every operation, and various methods have been renamed to be more consistent

Features

  • convert most methods to return promises, as webhid uses them even though node-hid doesnt. (7b1883b)
  • lerna (c942fb9)
  • publish demo to github pages (44428a2)
  • refactor into a separate node package (0e68e20)
  • remove exit-hook due to it potentially 'claiming' error handling (a4aca6b)
  • use eventemitter3 instead of node eventemitter (31e6bc3)
  • rename api methods to be clearer (e8777bb)

4.0.1 (2021-01-07)

Bug Fixes

  • don't require tslib in generated code (69e1dfe)

4.0.0 (2020-12-23)

BREAKING CHANGES

  • Drop support for node 8 or older

Features

  • support for buffers in any of rgb, rgba, bgr or bgra (088d979)

Bug Fixes

  • broken text-generation example (364f6de)
  • dependencies too new for node8 (875f5bd)

3.3.5 (2020-12-08)

3.3.3 (2020-12-04)

3.3.2 (2020-08-28)

3.3.1 (2020-07-18)

Bug Fixes

  • only audit dependencies (60e7cca)
  • only audit dependencies (60e7cca)
  • trim the serial number to 12 characters, as it always is currently (d371654)
  • trim the serial number to 12 characters, as it always is currently (d371654)

3.3.0 (2020-02-16)

Features

  • pass buffers to node-hid (d371969)
  • upgrade jpeg-turbo and expose quality options (344254a)

Bug Fixes

  • optimise buffer transform/color conversion (c5987ac)
  • remove dependency on node-hid typings for library users (f83ae99)
  • tests (b493274)
  • upgrade @types/node-hid (3d59a4f)

3.2.0 (2019-11-14)

Features

  • Add support for the new hardware version of the original Stream Deck (992ee21)
  • close device on process exit (105985e)
  • refactor originalv2 and xl to a shared base class (c9357ac)

Bug Fixes

  • add tests for original-v2 (40030a8)
  • line endings on windows (c0af2d6)
  • lint errors in origialv2 (d8e7942)

3.1.0 (2019-09-29)

Bug Fixes

  • xl: resetToLogo not working (2475726)

Features

  • Add close method to cleanly close the HID device (#72) (877b5da)

3.0.0 (2019-06-03)

Bug Fixes

  • Don't depend on tslib (3ebd04f)
  • Failing tests (c36125d)
  • xl: Fill full button with image. Fix images being horizontally flipped (4044809)
  • Gracefully handle missing jpeg-turbo (574068f)
  • ignore tests in coverage report. format config files. Add tests for device info and listing functions (2c1db92)
  • JPEG encoding tests (8efb092)
  • Mini image display (99c0c94)
  • Missing dependencies in travis (9e0f5b5)
  • Missing devDependency (f94ff51)
  • Move static device info methods to be separately importable. Reformat examples (6dfde88)
  • Refactor fillImage command generation, and some attempted fixes for the mini (15ce1f2)
  • Refactor the packet generation code to be simpler (d0ef9cf)
  • Remove padding from images for the mini (751fc62)
  • Switch to testing version of jpeg-turbo (01e2e30)
  • Test and fix some extra commands for the XL (7399b28)
  • Travis not updating coveralls (ea57f08)
  • update dependencies, and linux version used (8916aec)
  • Update node-hid to 0.7.9 (da010e5)

Features

  • Add example for device detection (81ad930)
  • Add function to list available devices (8c55598)
  • Add resetToLogo function, ideal for when disconnecting from the device to reset it back to default (1b94570)
  • Convert to typescript (a1492bd)
  • Functions to get firmware and serial numbers #45 (ba130b9)
  • Initial (untested) support for StreamDeck Mini (c41e684)
  • Port tests to jest and typescript (4ceaf90)
  • Refactor logic to have a common base class with each device extending it (8632d93)
  • Reimplement fillPanel to work solely on buffers. Fix up all the examples (f35c26c)
  • Removed references to sharp (BREAKING CHANGE) (d17b7c4)
  • Reorder the keys on the original to be left to right. The old behaviour can be restored if desired (fdff5f1)
  • Use jpeg-turbo as an optional dependency for image encoding, as it is significantly faster than jpeg-js but has a lot more dependencies (e7e509e)
  • Working XL, with slightly dodgey but working image transfer (eb294e8)

2.1.1 (2018-04-05)

Bug Fixes

  • package: pin node-hid to 0.6.0 (de5186a), closes #46

2.1.0 (2018-03-05)

Features

  • package: eliminate the need for compilation of dependencies on most platforms (9e5f338)

2.0.0 (2017-11-28)

Features

  • add fillPanel method
  • add clearAllKeys method
  • return the StreamDeck constructor instead of automatically instantiating it
  • allow providing a devicePath to the constructor
    • if no device path is provided, will attempt to use the first found Stream Deck. Errors if no Stream Decks are connected.
  • update this.keyState before emitting down and up events
    • this is technically a breaking change, but is very unlikely to affect any production code

Bug Fixes

  • fix center-cropping in fillImageFromFile
  • fix sharp only being a devDependency, and not a production dependency

Code Refactoring

  • refactor StreamDeck class to move as much as possible to static methods and static getters
  • refactor code to use async/await
    • this is a breaking change, because we now only support Node.js v7.6 or newer

Documentation

  • update all examples
  • add fillPanel example

BREAKING CHANGES

  • this.keyState is now updated before down and up events are emitted.
  • Support for versions of Node.js earlier than 7.6 has been dropped.
  • The StreamDeck constructor is now required when requireing this library, instead of an instance of the class. * See the docs for updated examples.

1.2.0 (2017-06-23)

Features

  • add clearKey method #4
  • add Typescript typings #13
  • add setBrightness and sendFeatureReport 4d904f0

Bug Fixes

  • throw an error when no stream decks are present c44a1bf
  • fix device detection on linux e0b128c
  • fillImage fix blue and red channels being swapped 8efdb6b

Misc

  • Full test coverage

1.1.0 (2017-05-18)

Features

  • add write method (0085d87)
  • add fillColor, fillImage, and fillImageFromFile methods (5fe46ef)

1.0.0 (2017-05-17)

Initial release.