From 0d23b4eac3ec7b5673f6a805f74d67630e4b2220 Mon Sep 17 00:00:00 2001 From: onyx-and-iris <75868496+onyx-and-iris@users.noreply.github.com> Date: Wed, 19 Jan 2022 22:48:26 +0000 Subject: [PATCH] update changelog, readme update changelog and readme to reflect recent changes --- CHANGELOG.md | 19 ++++++++++++++----- README.md | 18 ++++++++++++++++++ 2 files changed, 32 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5d8b1f0..af469e3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,11 +7,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 Before any minor/major patch is released all test units will be run to verify they pass. ## [Unreleased] -- [x] Add VMRemoteErrors class and subclass other error classes. -- [x] Rework set many parameters so class properties are set through the wrapper instead by VBVMR_SetParameters -- [x] Expose lower level setters and getters as well as polling parameters through Remote class. -- [x] Add throw LoginError if multiple login attempts are made. -- [x] Update pester tests to reflect latest changes +- [x] + +## [2.2] - 2021-01-19 +### Added +- Add VMRemoteErrors class and subclass other error classes. +- Expose lower level setters and getters as well as polling parameters through Remote class. +- README and CHANGELOG updated to reflect latest changes. +- Version 2.2 added to PSGAllery + +### Changed +- Rework set many parameters so class properties are set through the wrapper instead by VBVMR_SetParameters +- Rework meta module. Separate functions for each member type. +- Update pester tests to reflect latest changes +- Add throw LoginError if multiple login attempts are made. In testing the session was still crashing, however. ## [2.1] - 2021-01-11 ### Added diff --git a/README.md b/README.md index 58cdd64..aacd95f 100644 --- a/README.md +++ b/README.md @@ -172,6 +172,24 @@ try { finally { $vmr.Logout() } ``` +### Remote class +Access to lower level Getters and Setters are provided with these functions: +- `$vmr.Getter(param)`: For getting the value of a parameter expected to return a value other than string. +- `$vmr.Getter_String(param)`: For getting the value of any parameter expected to return a string. +- `$vmr.Setter(param, value)`: For setting the value of any parameter. + +Access to lower level polling functions are provided with these functions: +- `$vmr.PDirty`: Returns true if a parameter has been updated. +- `$vmr.MDirty`: Returns true if a macrobutton has been updated. + +example: +```powershell +$vmr.Getter('Strip[2].Mute') +$vmr.Getter_String('Bus[1].Label') +$vmr.Setter('Strip[4].Label', 'stripname') +$vmr.Setter('Strip[0].Gain', -3.6) +``` + ### Run tests Run tests using .\runall.ps1 which accepts two parameters: - tag Run tests of this type