{"id":16490374,"url":"https://github.com/ryansn/doxie-node","last_synced_at":"2025-03-16T18:31:53.923Z","repository":{"id":42210508,"uuid":"150169882","full_name":"ryanSN/doxie-node","owner":"ryanSN","description":"Node.js API library for getting scans off your Doxie go, Doxie Q, and Doxie go SE scanners ❤️","archived":false,"fork":false,"pushed_at":"2025-03-12T05:49:58.000Z","size":1975,"stargazers_count":13,"open_issues_count":8,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-12T06:28:05.348Z","etag":null,"topics":["doxie","doxie-api","doxie-go","doxie-go-se","doxie-q","doxie-scanner","doxie-wifi","hacktoberfest","hacktoberfest2021","javascript","nodejs","sdk"],"latest_commit_sha":null,"homepage":"https://ryansn.github.io/doxie-node","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ryanSN.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-09-24T21:19:15.000Z","updated_at":"2023-04-29T08:11:14.000Z","dependencies_parsed_at":"2023-02-05T02:01:26.955Z","dependency_job_id":"d19a6bf2-b882-4232-a5ac-8bf6be85779f","html_url":"https://github.com/ryanSN/doxie-node","commit_stats":{"total_commits":140,"total_committers":6,"mean_commits":"23.333333333333332","dds":0.4285714285714286,"last_synced_commit":"a59559df26a90ad5daff62dfea08ea2906bde486"},"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryanSN%2Fdoxie-node","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryanSN%2Fdoxie-node/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryanSN%2Fdoxie-node/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryanSN%2Fdoxie-node/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ryanSN","download_url":"https://codeload.github.com/ryanSN/doxie-node/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243826783,"owners_count":20354220,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["doxie","doxie-api","doxie-go","doxie-go-se","doxie-q","doxie-scanner","doxie-wifi","hacktoberfest","hacktoberfest2021","javascript","nodejs","sdk"],"created_at":"2024-10-11T13:47:50.265Z","updated_at":"2025-03-16T18:31:52.692Z","avatar_url":"https://github.com/ryanSN.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# doxie-node\n\n[![CI](https://github.com/ryanSN/doxie-node/workflows/CI/badge.svg)](https://github.com/ryanSN/doxie-node/actions?query=workflow%3ACI)\n[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/ryanSN/doxie-node/blob/master/LICENSE)\n[![npm](https://img.shields.io/npm/v/doxie-node.svg)](https://npmjs.com/package/doxie-node)\n[![Coverage Status](https://coveralls.io/repos/github/ryanSN/doxie-node/badge.svg?branch=master)](https://coveralls.io/github/ryanSN/doxie-node?branch=master)\n\n#### Node.js library for Doxie go Wi-fi, Doxie Q, and Doxie Go SE\n\nThis is a Node js wrapper library/SDK for the API provided from the [Doxie series of Wi-Fi document scanners.](http://www.getdoxie.com/)\n\n### Documentation\n\nSee [Doxie's offical API documentation](http://help.getdoxie.com/doxiego/advanced/wifi/api/)\n\n### installation\n\n`yarn add doxie-node`\n\nor\n\n`npm install doxie-node --save`\n\n### Usage / Initialize\n\nThis requires knowing your Doxie's IP address on your network.\nAll methods return a promise.\n\n```js\nimport doxieNode from 'doxie-node';\nconst doxie = new doxieNode({ doxieURL: 'http://192.168.1.3' });\n```\n\n#### Available options\n\ndoxie-node can take the following options:\n\n- `username` **optional** - defaults:`doxie`\n- `password` **optional**\n- `token` **optional** - base64 encoded username and password token (ie. Basic [token]) if username and password provided, this token is created for you.\n- `doxieURL` **required**\n- `doxiePort` **optional** - default:`8080`\n\n## Methods\n\n### `hello`\n\nUsed to check the status of your Doxie.\nIf calling on a Doxie go SE or Doxie Q the return will include the `firmware` and `connectedToExternalPower`.\n\n```js\nreturn doxie.hello().then(response);\n```\n\n#### returns\n\n```js\n{\n  model: 'DX250',\n  name: 'Doxie_042D6A',\n  firmwareWiFi: '1.29',\n  hasPassword: false,\n  MAC: '00:11:E5:04:2D:6A',\n  mode: 'AP'\n}\n```\n\n### `scanner_status` (Only for Doxie Go Wi-Fi)\n\nThis method was deprecated for Doxie go SE, Doxie Q\n\n#### returns\n\n```js\n{\n \"firmware\": \"0.26\",\n \"connectedToExternalPower\": true\n}\n```\n\n### `restart`\n\nreturns 204 No Content and then restarts the scanner's Wi-Fi\nsystem. The scanner's status light blinks blue during the restart.\n\n```js\nreturn doxie.restart().then(response);\n```\n\n### `list_all_scans`\n\nreturns an array of all scans currently in the scanner’s memory. After\nscanning a document, the scan will available via the API several second later\n\n```js\nreturn doxie.list_all_scans().then(response);\n```\n\n#### returns\n\n```js\n[\n  {\n    name: '/DOXIE/JPEG/IMG_0001.JPG',\n    size: 241220,\n    modified: '2010-05-01 00:10:06'\n  },\n  {\n    name: '/DOXIE/JPEG/IMG_0002.JPG',\n    size: 265085,\n    modified: '2010-05-01 00:09:26'\n  },\n  {\n    name: '/DOXIE/JPEG/IMG_0003.JPG',\n    size: 273522,\n    modified: '2010-05-01 00:09:44'\n  }\n];\n```\n\n### `most_recent_scan`\n\nreturns the path to the last scan if available. Monitoring this value\nfor changes provides a simple way to detect new scans without having to fetch the entire list of\nscans.\n\n```js\nreturn doxie.most_recent_scan().then(response);\n```\n\n#### returns\n\n```js\n{\n \"path\":\"/DOXIE/JPEG/IMG_0003.JPG\"\n}\n```\n\n### `get_scan`\n\nreturns the scan at the specified path or 404 Not Found\nThis method also will retry (`default: 3`) when a 404 is not found assuming the image\nis not ready.\n\n#### params\n\n- `scanPath` **required** - String (ie. `'/DOXIE/JPEG/IMG_0001.JPG'`)\n- `retries` **optional** - `default: 3` - Number of retires to attempt when image is not ready\n\n```js\nreturn doxie.get_scan('/DOXIE/JPEG/IMG_0001.JPG').then(response);\n```\n\n### `get_thumbnail`\n\nThumbnails are constrained to fit within 240x240 pixels. Thumbnails for new scans are not\ngenerated until after the scan has been made available in `get_scan()` and `most_recent_scan()`.\nThis function will return 404 Not Found if the thumbnail has not yet been\ngenerated. This method also will retry (`default: 3`) when a 404 is not found assuming\nthe image is not ready.\n\n#### params\n\n- `scanPath` **required** - String (ie. `'/DOXIE/JPEG/IMG_0001.JPG'`)\n- `retries` **optional** - `default: 3` - Number of retires to attempt when image is not ready\n\n```js\nreturn doxie.get_thumbnail('/DOXIE/JPEG/IMG_0001.JPG').then(response);\n```\n\n#### returns on success the stream of the thumbnail\n\n`200`\n\n#### returns on failure\n\n`404 Not Found`\n\n### `delete_scan`\n\ndeletes the scan at the specified path\n\n```js\nreturn doxie.delete_scan('/DOXIE/JPEG/IMG_0001.JPG').then(response);\n```\n\n#### returns on success\n\n`204 No Content`\n\nwhen deleteing multiple scans use `delete_mutiple_scans` for the best performance.\n\n### `delete_multiple_scans`\n\ndeletes multiple scans in a single operation. This is much faster\nthan deleting each scan individually. Multiple scans are referenced using a JSON array of paths\n\n```js\nconst scans = [\n  '/DOXIE/JPEG/IMG_0001.JPG',\n  '/DOXIE/JPEG/IMG_0002.JPG',\n  '/DOXIE/JPEG/IMG_0003.JPG'\n];\nreturn doxie.delete_multiple_scans(scans).then(response);\n```\n\n#### returns on success\n\n`204 No Content`\n\n### Development\n\n- `yarn install`\n- `yarn test` to run tests\n\n## deployment\n\n- `npm version [minor, patch, major]`\n- `git push origin master --tag`\n  Auto publishes on tag commit to master.\n  or\n- `git push --follow-tags`\n\nThis library is released under the [MIT License](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fryansn%2Fdoxie-node","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fryansn%2Fdoxie-node","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fryansn%2Fdoxie-node/lists"}