# solarmon

> [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

Latest version **0.1.0** (published 2019-06-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install solarmon
pnpm add solarmon
yarn add solarmon
bun add solarmon
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2019-06-28 |
| First published | 2019-06-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 43.9 KB |
| Known vulnerabilities | 0 (+25 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Marcelo Alves |
| Maintainers | marceloalves |

## Links

- npm: https://www.npmjs.com/package/solarmon
- Repository: https://github.com/marceloalves/solarmon
- Homepage: https://github.com/marceloalves/solarmon#readme
- Issues: https://github.com/marceloalves/solarmon/issues
- npm.io page: https://npm.io/package/solarmon

## Dependencies (1)

- [axios](https://npm.io/package/axios.md) ^0.19.0

## Recent versions

- 0.1.0 (latest) — 2019-06-28

## README

# SolarMon

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)


API wrapper for the [SolarEdge Monitoring API](https://www.solaredge.com/sites/default/files/se_monitoring_api.pdf)

This project was bootstrapped with [TSDX](https://github.com/jaredpalmer/tsdx).

## Usage

Setup the client

```javascript
import solarmon from 'solarmon'

const client = new solarmon.client('apiKey123')
```

Get a list of sites

```javascript
client.site.list().then(r => console.log(r))
```

Get the site overview

```javascript
client.site.overview('siteId123').then(r => console.log(r))
```
## Contributing

### Local Development

Below is a list of commands you will probably find useful.

#### `npm start` or `yarn start`

Runs the project in development/watch mode. Your project will be rebuilt upon changes. TSDX has a special logger for you convenience. Error messages are pretty printed and formatted for compatibility VS Code's Problems tab.

Your library will be rebuilt if you make edits.

#### `npm run build` or `yarn build`

Bundles the package to the `dist` folder.
The package is optimized and bundled with Rollup into multiple formats (CommonJS, UMD, and ES Module).

#### `npm test` or `yarn test`

Runs the test watcher (Jest) in an interactive mode.
By default, runs tests related to files changed since the last commit.

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