https://github.com/hensm/node-ddcci

NodeJS DDC/CI library
https://github.com/hensm/node-ddcci

Last synced: over 1 year ago
JSON representation

NodeJS DDC/CI library

• Host: GitHub
• URL: https://github.com/hensm/node-ddcci
• Owner: hensm
• Created: 2018-06-08T20:17:37.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2020-11-29T11:28:57.000Z (over 5 years ago)
• Last Synced: 2025-04-18T00:56:59.784Z (over 1 year ago)
• Language: C++
• Size: 28.3 KB
• Stars: 64
• Watchers: 2
• Forks: 11
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# node-ddcci

## Installation

node-ddcci is currently only supported on Windows.

````bash

npm install @hensm/ddcci

````

## Usage

````js

const ddcci = require("@hensm/ddcci");

for (const monitor of ddcci.getMonitorList()) {

    console.log(`${monitor} current brightness: ${ddcci.getBrightness(monitor)}`);

    ddcci.setBrightness(monitor, 25);

}

````

## Docs

* ### `getMonitorList()`

  Gets a list of the current connected monitors.

  * #### Return value

    An array of `String` containing the monitor IDs.

* ### `getBrightness(monitorId)`

  Queries a monitor's brightness level.

  * #### Parameters

    * **`monitorId`**  

      `String`. ID of monitor for which to query the brightness.

  * #### Return value

    An `integer`, typically between 0-100, representing the current brightness.

    

* ### `getMaxBrightness(monitorId)`

  Queries a monitor's maximum brightness level.

  * #### Parameters

    * **`monitorId`**  

      `String`. ID of monitor for which to query the brightness.

  * #### Return value

    An `integer`, typically between 0-100, representing the maximum brightness.

* ### `setBrightness(monitorId, level)`

  Sets a monitor's brightness level.

  * #### Parameters

    * **`monitorId`**  

      `String`. ID of monitor for which to set the brightness.

    * **`level`**  

      `integer`. Between 0-100 representing the new brightness level.

* ### `getContrast(monitorId)`

  Queries a monitor's contrast level.

  * #### Parameters

    * **`monitorId`**  

      `String`. ID of monitor for which to query the contrast.

  * #### Return value

    An `integer`, typically between 0-100, representing the current contrast.

    

* ### `getMaxContrast(monitorId)`

  Queries a monitor's maximum contrast level.

  * #### Parameters

    * **`monitorId`**  

      `String`. ID of monitor for which to query the contrast.

  * #### Return value

    An `integer`, typically between 0-100, representing the maximum contrast.

* ### `setContrast(monitorId, level)`

  Sets a monitor's contrast level.

  * #### Parameters

    * **`monitorId`**  

      `String`. ID of monitor for which to set the contrast.

    * **`level`**  

      `integer`. Between 0-100 representing the new contrast level.

* ### `_getVCP(monitorId, vcpCode)`

  Queries a monitor for a VCP code value.

  * #### Parameters

    * **`monitorId`**  

      `String`. ID of monitor for which to query the VCP feature.

    * **`vcpCode`**  

      `integer`. VCP code to query

  * #### Return value

    An `array` of two `integer` values in the format of `[currentValue, maxValue]`.

* ### `_setVCP(monitorId, vcpCode, value)`

  Sets the value of a VCP code for a monitor.

  * #### Parameters

    * **`monitorId`**  

      `String`. ID of monitor for which to set the VCP feature.

    * **`vcpCode`**  

      `integer`. VCP code to set.

    * **`value`**  

      `integer`. Value of the VCP code.

* ### `_refresh()`

  Refreshes the monitor list.