npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

zabbix-api-ts

v0.0.2

Published

TypeScript module for working with the Zabbix API

Downloads

2

Readme

This is a Zabbix API component to use with TypeScript.

The following API methods have been implemented:

The package was tested with Zabbix 5.4.

Examples:


Logging in and logging out

import { ZabbixAPI } from "zabbix-api-ts";

import dotenv from 'dotenv'

dotenv.config();

const main = async function() {

  // Initialize ZabbixAPI instance.
  const zabbix = new ZabbixAPI(process.env.zabbixURL!, process.env.zabbixUsername!, process.env.zabbixPassword!);

  // Login.
  const loginResult = await zabbix.login();
  if(loginResult.result) {

    // Logout.
    const logoutResult = await zabbix.logout();

    // Output logout response.
    console.log(logoutResult);
  }
}

main();

// Outputs:
//   {jsonrpc: '2.0', result: true, id: 4}

Retrieving hosts

import { ZabbixAPI } from "zabbix-api-ts";

import dotenv from 'dotenv'

dotenv.config();

const main = async function() {
  
  // Initialize ZabbixAPI instance.
  const zabbix = new ZabbixAPI(process.env.zabbixURL!, process.env.zabbixUsername!, process.env.zabbixPassword!);

  // Login.
  const loginResult = await zabbix.login();
  if(loginResult.result) {
    // Get all hosts, filter Arduino hosts.
    const arduinoHosts = (await zabbix.getHosts()).result
      .filter((el) => { return el.name.includes('Arduino'); })
        .map(el => { return el.name; });
    
    // Logout.
    await zabbix.logout();

    // Output results.
    console.log(arduinoHosts);
  }
}

main();

// Output:
//   (9) ['Arduino_09_307', 'Arduino_09_434' ... 'Arduino_09_432_B', 'Arduino_09_435']

Retrieving host items

import { ZabbixAPI } from "zabbix-api-ts";

import dotenv from 'dotenv'

dotenv.config();

const main = async function() {
  // Initialize ZabbixAPI instance.
  const zabbix = new ZabbixAPI(process.env.zabbixURL!, process.env.zabbixUsername!, process.env.zabbixPassword!);

  // Login.
  const loginResult = await zabbix.login();
  if(loginResult.result) {

    // Retrieve all hosts, filter ZigBee smart plug host.
    const smartPlug = (await zabbix.getHosts()).result
      .filter((el) => { return el.name.includes('ZigBee socket'); })[0];
    
    // Logout.
    await zabbix.logout();

    // Output results.
    console.log(smartPlug.name);
    for(const item of smartPlug.items.filter((el) => { return el.name.toLowerCase().includes('power (') })) {
      console.log(`  ${item.name}: ${item.lastvalue} ${item.units.replace('!', '')}`)
    }
  }
}

main();

// Output:
//   ZigBee socket JLT1 bffdb1768fdc36f6d0edsb
//     Power (bffdb1768fdc36f6d0edsb): 38
//     Cumulative power (bffdb1768fdc36f6d0edsb): 77.44

Retrieving host item history

import { ZabbixAPI } from "zabbix-api-ts";

import dotenv from 'dotenv'

dotenv.config();

const main = async function() {
  
  // Initialize ZabbixAPI instance.
  const zabbix = new ZabbixAPI(process.env.zabbixURL!, process.env.zabbixUsername!, process.env.zabbixPassword!);

  // Login.
  const loginResult = await zabbix.login();
  if(loginResult.result) {
    
    // Retrieve all hosts, filter ZigBee smart plug host.
    const smartPlug = (await zabbix.getHosts()).result
      .filter((el) => { return el.name.includes('ZigBee socket'); })[0];
    
    // Find first item related to power consumption.
    const item = smartPlug.items.filter((el) => { return el.name.includes('Power (') })[0];

    // Get current unix time.
    const unixTime = Math.round(new Date().getTime() / 1000);

    // Retrieve item history.
    const history = await zabbix.getHistory(
      [parseInt(item.itemid)],   // Unique item ID.
      parseInt(item.value_type), // Item value type (in this case - float).
      unixTime - 6000,           // Current time minus 6000 seconds.
      unixTime                   // Current time.
    );

    // Logout.
    await zabbix.logout();

    // Output results.
    console.log(smartPlug.name);
    for(const historyResult of history.result) {
      const time = new Date(Number(historyResult.clock) * 1000)
        .toLocaleDateString('lt-LT', { hour: '2-digit', minute: '2-digit', second: '2-digit', hour12: false});
      const value = `${historyResult.value} ${item.units.replace('!', '')}`
      console.log(`  ${time}: ${value}`)
    }
  }
}

main();

// Output:
//  ZigBee socket JLT1 bffdb1768fdc36f6d0edsb
//    2023-05-25 14:27:03: 47 W
//    2023-05-25 14:12:03: 46 W
//    2023-05-25 13:57:03: 47 W
//    2023-05-25 13:42:03: 50 W
//    2023-05-25 13:27:04: 44 W
//    2023-05-25 13:12:03: 51 W
//    2023-05-25 12:57:03: 42 W