# screen-brightness

> Analyze screen contents to get brightness

Latest version **0.0.1** (published 2016-11-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install screen-brightness
pnpm add screen-brightness
yarn add screen-brightness
bun add screen-brightness
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2016-11-30 |
| First published | 2016-11-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 6.x |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Emmanuel Pilande |
| Maintainers | epilande |

## Links

- npm: https://www.npmjs.com/package/screen-brightness
- npm.io page: https://npm.io/package/screen-brightness

## Dependencies (2)

- [robotjs](https://npm.io/package/robotjs.md) ^0.4.5
- [tinycolor2](https://npm.io/package/tinycolor2.md) ^1.4.1

## Recent versions

- 0.0.1 (latest) — 2016-11-30

## README

# screen-brightness
> Analyze screen contents to get brightness


## Installation
```bash
$ npm install --save screen-brightness
```


## Usage
```javascript
const screenBrightness = require('screen-brightness');

screenBrightness();   //=> 52.48828125
```

`screenBrightness` returns a number between `0` - `255`, depending on how bright the content on your
screen is.


## API

### screenBrightness([options])

#### options
Type: `Object`

##### columns
Type: `number`<br>
Default: `8`

Columns throughout the screen where points will be plotted.

##### points
Type: `number`<br>
Default: `32`

Total points to take color samples from.

---
_Source: https://npm.io/package/screen-brightness · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._