Skip to main content

Module for interacting with OpenWrt Luci RPC interface

Project description

openwrt-luci-rpc

https://img.shields.io/pypi/v/openwrt_luci_rpc.svg https://img.shields.io/travis/fbradyirl/openwrt-luci-rpc.svg Documentation Status

Python3 module for interacting with the OpenWrt Luci RPC interface

Features

  • Allows you to use the Luci RPC interface to fetch connected devices on your OpenWrt based router.
  • Supports 17.X & 18.X or newer releases of OpenWrt.

Usage

You will first need to install the package luci-mod-rpc on your OpenWrt router.

opkg update
opkg install luci-mod-rpc

Once that is done, you can use this module to interact with the RPC interface.

Install

pip install openwrt-luci-rpc

Use

from openwrt_luci_rpc import OpenWrtRpc

router = OpenWrtRpc('192.168.1.1', 'root', 'mypassword')
result = router.get_all_connected_devices(only_reachable=True)

for device in result:
   mac = device.mac
   name = device.hostname

   # convert class to a dict
   device_dict = device._asdict()

Development

See contributing guide.

History

0.1.0 (2019-02-19)

  • Initial release. Not working. Do not use.

0.2.0 (2019-02-19)

  • Initial release. Not working. Do not use.

0.3.0 (2019-02-19)

  • First working release on PyPI.

0.4.8 (2019-02-20)

  • Fix travis deploy repo, once more.

0.4.9 (2019-02-20)

  • Fix README formatting for docs.

0.4.10 (2019-02-20)

  • Fix links to github repo

0.4.11 (2019-02-20)

  • Updated usage in README.

0.4.12 (2019-02-20)

  • Fix typo in README.

0.4.13 (2019-02-20)

  • Fix README parse issue.

1.0.0 (2019-02-21)

  • Updated to return all device information.
  • Added extra unit tests.

1.0.1 (2019-02-22)

  • Minor bug fixes and extra unit tests

1.0.2 (2019-02-22)

  • Logging fixes around token refresh

1.0.3 (2019-02-22)

  • Fix History.rst formatting issue.

1.0.4 (2019-02-22)

  • Take SSL param in init now
  • Fix some typos

1.0.5 (2019-02-22)

  • As a convenience, as the router IP as the host for every device. Can be useful when a network has more than one router.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for openwrt-luci-rpc, version 1.0.5
Filename, size File type Python version Upload date Hashes
Filename, size openwrt_luci_rpc-1.0.5-py2.py3-none-any.whl (8.2 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size openwrt-luci-rpc-1.0.5.tar.gz (12.5 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page