Narcissistic Preening Monarch
    Have ideas to improve npm?Join in the discussion! »

    wifiradio

    0.4.0 • Public • Published

    WiFi-Radio

    dependencies Status Travis NPM Version NPM Downloads

    NodeJS module for controlling WiFi-radios

    Installation

    npm install wifiradio --save
    

    Usage

    const Wifiradio = require('wifiradio');
     
    const ip = '192.168.178.27'; // Change this to the ip adress of your radio
    const pin = '1234'; // This is the default PIN for the radio. (Works in most cases)
     
    const radio = new Wifiradio(ip, pin);
     
    radio.setPower(1).then(() => {
      radio.getPower().then(result => {
        console.log(`Power: ${result}`);
      });
    });
     
    radio.getMute().then(result => {
      console.log(`Mute: ${result}`);
    });
     
    radio.getText().then(result => {
      console.log(`Text: ${result}`);
    });
     
    radio.getMode().then(result => {
      console.log(`Mode: ${result}`);
    });

    Features

    This page lists all commands that are directly accessible with the use of this library. These commands only provide a very simple high-level access to the features of your radio.

    ⚠️ For more advanced use cases I suggest that you may take a look at this very extensive list of possible commands and don't use the functions listed below but rather access the API via the following function for direct access:

    Direct Access

    radio.get('sys.sleep').then(console.log);
    radio.get('netRemote.sys.sleep').then(console.log);
     
    radio.set('sys.sleep', 60).then(console.log);
     
    radio.get('sys.info.friendlyname').then(console.log);
    radio.set('sys.audio.volume', 5).then(console.log);

    Power

    // Turn on
    radio.setPower(1);
     
    // Turn off
    radio.setPower(0);
     
    // Get whether the radio is on or off (returns 0 or 1)
    radio.getPower().then(console.log);

    Mute

    // Mute on
    radio.setMute(1);
     
    // Mute off
    radio.setMute(0);
     
    // Get whether the radio is mute or not (returns 0 or 1)
    radio.getMute().then(console.log);

    Volume

    // Set volume (value from 1-20)
    radio.setVolume(10);
     
    // Get the current volume (returns a value from 1-20)
    radio.getVolume().then(console.log);

    Modes

    // Set a mode
    radio.setMode(2);
     
    // Get the current playing mode
    radio.getMode().then(console.log);

    Display

    // Get the first line of the display
    radio.getName().then(console.log);
     
    // Get the second line of the display
    radio.getText().then(console.log);

    Contributing

    There are many more requests that could be done by this module. If you think that something is missing just open an issue for that or make a pull request. If you need some help, you can have a look here for some further requests.

    License

    GPL-3.0

    Install

    npm i wifiradio

    DownloadsWeekly Downloads

    4

    Version

    0.4.0

    License

    GPL-3.0

    Unpacked Size

    44.2 kB

    Total Files

    5

    Last publish

    Collaborators

    • avatar