Skip to main content

A library for managing home routers (networking equipment).

Project description

roscraco (short for ROuter SCRAping and COntrol) is a library for managing networking devices (routers).

The targeted (and currently supported) devices are home routers.

Settings are fetched and pushed from/to devices by using their standard web-management interface (HTTP).

The type of device being managed is abstracted away and is only important initially (when the controller object is created). From the developer’s standpoint, settings are then managed the same way regardless of the device’s type.

Supported devices

The library supports the following devices:

  • TP-Link
    • WR340G

    • WR740N

    • WR741N

    • WR940N

    • WR941N

  • Netgear
    • WGR614v7

    • WGR614v8

    • WGR614v9

  • Canyon
    • CNWF514

    • CNPWF514N1

  • Zyxel
    • P320W

  • Tomato (routers using Tomato firmware)
    • version 1.23

Supported features

  • Fetching router information (MAC address, uptime, DNS servers, traffic statistics, connected clients)

  • Fetching DHCP server settings

  • Fetching and updating DMZ settings

  • Fetching and updating DHCP address reservation settings

  • Fetching and updating Wireless connectivity settings

  • Rebooting

Some of the (usually more advanced) options of a given settings object cannot be controlled. For most of these options a “sane” value (usually default) is picked and will potentially overwrite any custom values that are currently set.

Usage example

Creating a controller instance:

import roscraco
controller = roscraco.create_controller(
    roscraco.ROUTER_TP_LINK, 'WR340G',
    'localhost', 8080, 'username', 'password'
)

Print a lot of information about the device:

roscraco.helper.print_info(controller)

Change some Wireless settings:

# Fetch the current wireless settings
settings = controller.get_wireless_settings()

# Switch to the next transmission channel
settings.set_channel(setings.channel + 1)

# Disable password authentication
settings.set_security_type(settings.SECURITY_TYPE_NONE)

# Change the SSID (network name)
settings.set_ssid('NewNetworkName')

# Send the new wireless settings to the router
controller.push_wireless_settings(settings)

Be nice and log out of the device properly (you can also use contextlib.closing):

controller.close()

Project details


Download files

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

Source Distribution

roscraco-0.1.1.tar.gz (37.7 kB view details)

Uploaded Source

File details

Details for the file roscraco-0.1.1.tar.gz.

File metadata

  • Download URL: roscraco-0.1.1.tar.gz
  • Upload date:
  • Size: 37.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for roscraco-0.1.1.tar.gz
Algorithm Hash digest
SHA256 9e580c8ee10e2e9e9a311deeefbca0f5cdfc402f5c85abd32657d73856d05abf
MD5 04bfaf6151bc30d88effb89eb4096b90
BLAKE2b-256 cc4639b00bf6763093f6a006ff96c3e470875f1732bc410c0f0b9d0e8b3424ea

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page