1.0.0 • Published 1 year ago

homebridge-juicebox v1.0.0

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
1 year ago

npm verified-by-homebridge

Homebridge JuiceBox

Connect your Enel X JuiceBox (JuiceNet) to HomeKit.

Shows as outlets in HomeKit. Also exposes the "in use" characteristic for when a car is plugged in or not ("in use" can be true even when the charger is not providing power), as well as the Volts, Amps, Watts, Kilowatt Hours, and Current Temperature as reported by each device.

Stopping charging attempts to act as much like stopping charging from the "EV JuiceNet" app as possible (which appears to be achieved by delaying charging for ~1 year).

Setup

To get your JuiceNet API Token, go to https://home.juice.net/Manage and click "Generate API Token".

If you have multiple JuiceBox devices on your account, but only want to expose some of them (e.g. for different homes) then you can specify ignoredIds - device IDs can be found at https://home.juice.net/Portal.

Example config.json:

{
    "platform": "JuiceBoxHomebridgePlugin"
    "apiToken": "...required...",
    "ignoredIds": [
        "...optional..."
    ]
}

Thanks

  • Thanks to @ketsugi for the initial implementation of the JuiceNet API.
  • Thanks to @bwp91 for transferring the ownership of "homebridge-juicebox" on npm.

Development

Setup Development Environment

To develop Homebridge plugins you must have Node.js 12 or later installed, and a modern code editor such as VS Code. This plugin template uses TypeScript to make development easier and comes with pre-configured settings for VS Code and ESLint. If you are using VS Code install these extensions:

Install Development Dependencies

Using a terminal, navigate to the project folder and run this command to install the development dependencies:

npm install

Build Plugin

TypeScript needs to be compiled into JavaScript before it can run. The following command will compile the contents of your src directory and put the resulting code into the dist folder.

npm run build

Link To Homebridge

Run this command so your global install of Homebridge can discover the plugin in your development environment:

npm link

You can now start Homebridge, use the -D flag so you can see debug log messages in your plugin:

homebridge -D

Watch For Changes and Build Automatically

If you want to have your code compile automatically as you make changes, and restart Homebridge automatically between changes you can run:

npm run watch

This will launch an instance of Homebridge in debug mode which will restart every time you make a change to the source code. It will load the config stored in the default location under ~/.homebridge. You may need to stop other running instances of Homebridge while using this command to prevent conflicts. You can adjust the Homebridge startup command in the nodemon.json file.

Customise Plugin

Publish Package

When you are ready to publish your plugin to npm, make sure you have removed the private attribute from the package.json file then run:

npm publish

If you are publishing a scoped plugin, i.e. @username/homebridge-xxx you will need to add --access=public to command the first time you publish.

Publishing Beta Versions

You can publish beta versions of your plugin for other users to test before you release it to everyone.

# create a new pre-release version (eg. 2.1.0-beta.1)
npm version prepatch --preid beta

# publsh to @beta
npm publish --tag=beta

Users can then install the beta version by appending @beta to the install command, for example:

sudo npm install -g homebridge-juicebox@beta

Disclaimers

Apache License Version 2.0

This is not an officially supported Google product.

1.0.0

1 year ago

0.10.0

1 year ago

0.11.0

1 year ago

0.2.7

2 years ago

0.2.6

2 years ago

0.2.5

2 years ago

0.2.4

2 years ago

0.2.3

2 years ago

0.2.2

2 years ago

0.2.1

2 years ago

0.2.0

2 years ago

0.1.1

2 years ago