https://github.com/cbetta/doxie-scanner

🖨 A network scanner to find your the Doxie Go Wifi.
https://github.com/cbetta/doxie-scanner

api client-library discovery doxie doxie-scanner scanner sdk wifi

Last synced: 4 months ago
JSON representation

🖨 A network scanner to find your the Doxie Go Wifi.

• Host: GitHub
• URL: https://github.com/cbetta/doxie-scanner
• Owner: cbetta
• License: mit
• Created: 2016-05-30T00:04:31.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2020-05-13T12:57:17.000Z (about 6 years ago)
• Last Synced: 2026-02-15T06:17:52.249Z (4 months ago)
• Topics: api, client-library, discovery, doxie, doxie-scanner, scanner, sdk, wifi
• Language: Ruby
• Homepage:
• Size: 24.4 KB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
# Doxie Scanner

[![Gem Version](https://badge.fury.io/rb/doxie-scanner.svg)](https://badge.fury.io/rb/doxie-scanner) [![Build Status](https://travis-ci.com/cbetta/doxie-scanner.svg?branch=master)](https://travis-ci.com/cbetta/doxie-scanner)

A scanner to find your WiFi enabled [Doxie](http://getdoxie.com) scanner. It returns a list of IP addressess for all Doxie scanners discovered on your network. 

This Gem is especially useful in combination with the [Doxie client library](https://github.com/cbetta/doxie).

## Installation

Either install directly or via bundler.

```rb

gem 'doxie-scanner'

```

## Usage

The scanner uses UPnP and SSDP to search for your Doxie scanner.

```rb

require 'doxie/scanner'

Doxie::Scanner.ips

=> [

    [0] "192.168.1.2"

]

```

For usage with the [Doxie client library](https://github.com/cbetta/doxie) you can use the `.devices` method to automatically detect the model number and IP.

```rb

require 'doxie'

require 'doxie/scanner'

client = Doxie::Client.new(Doxie::Scanner.devices.first)

```

## Contributing

 1. **Fork** the repo on GitHub

 2. **Clone** the project to your own machine

 3. **Commit** changes to your own branch

 4. **Push** your work back up to your fork

 5. Submit a **Pull request** so that we can review your changes

### Development

* `bundle install` to get dependencies

* `rake` to run all tests

* `rake console` to run a local console with the library loaded

## License

This library is released under the [MIT License](LICENSE).