NOTE: To use cli it's recommend to install library globally (npm i -g onkyo.js). Otherwise you can start cli by calling ./cli.js in project root folder.
`` $ onkyo.js
Keys 1 - set FM 2 - set CBL/SAT 3 - set BD/DVD 5 - set CD 6 - set NET + - volUp - - volDown p - pwrToggle c - set ÇD s - set Stereo d - set direct t - set Thx m - toggle Mute ctrl+c - Exit `
Example:
discover first Onkyo/Pioneer receiver and use it ` const {OnkyoDiscover} = require('onkyo.js'); OnkyoDiscover.DiscoverFirst() .then((onkyo) => { return onkyo.powerOn(); }); `
use Onkyo by it's address ` const {Onkyo} = require('onkyo.js'); const onkyo = Onkyo({address: '192.168.0.100'}); onkyo.powerOn(); `
discover * discoverFirst or OnkyoDiscover.DiscoverFirst() without instance * close * listen
OnkyoDiscover instance inherits EventEmitter and trigger following events:
*
detected * error
$3
options: * logger (optional, e.g wiston instance) * name (optional) * address / ip * port (optional, default 60128)
Onkyo instance inherits EventEmitter and trigger following events: *
connected When connection is established * disconnect When connection is lost * error When something wrong happens or received message that library cannot handle
` onkyo.sendCommand(, ); ` Where group is one of string from OnkyoCmds.getGroups() and command is one of string from OnkyoCmds.getGroupCommands(group) .
Sending raw command:
` onkyo.sendRawCommand() `
Basic API:
` // power onkyo.isOn() // resolves true if powers on onkyo.isOff() // resolves true if powers off onkyo.pwrToggle() // toggle power, resolves when ready onkyo.pwrOn() // power on, resolves when ready onkyo.pwrOff() // power off, resolves when ready
// volume onkyo.volUp() // volume +1, resolves when ready onkyo.volDown() // volume -1, resolves when ready onkyo.setVolume(, ) // volume between 0-100, resolves when ready onkyo.getVolume() // resolves current volume
// mute onkyo.mute() // mute, resolves when ready onkyo.unMute() // unmute, resolves when ready onkyo.getMute() // resolves true if mute is on
// source/input onkyo.getSource() // resolves current source/input onkyo.setSource(, ) // source selection, resolves when ready
// sound mode onkyo.getSoundMode() // resolves current sound mode onkyo.setSoundMode(, ) // sound mode selection, resolves when ready
// remote control keys onkyo.sendRemoteKey() // possible values: MENU, UP, DOWN, LEFT, RIGHT, ENTER, EXIT, VIDEO, AUDIO, HOME
` \* is optional and by default control main zone, for other zones add "zone2"or "zone3".
Onkyo instance generates public API's based on onkyo.commands.js -file and contains following Promise API's: