Metadata-Version: 2.1
Name: neotools
Version: 0.2
Summary: Command line tools for AlphaSmart NEO
Home-page: https://github.com/lykahb/neotools
Author: Boris Lykah
License: GNU GPL 3
Project-URL: Bug Tracker, https://github.com/lykahb/neotools/issues
Description: # NeoTools
        
        Command-line tools for AlphaSmart NEO.
        
        This project aims to provide common functionality like file management, as well as 
        access to the low-level system details.
        The device driver has been ported from [AlphaSync](https://github.com/tSoniq/alphasync/).
        
        ## Commands
        
        Read file by index.
        
        ```bash
        > neotools files read 1
        Once upon a time...
        ````
        
        Read file by name. Enter the name as it appears on your Neo, without extension.
        
        ```bash
        > neotools files read intro
        Introduction: ...
        ````
        
        Copy all files to the directory, preserving their names.
        ```bash
        > neotools files read-all --path archives/
        > ls archives
        'File 1.txt'    'File 3.txt'    intro.txt
        ```
        
        Write file to Neo. It can write both by index and file name.
        ```bash
        > neotools files write notes.txt 1
        > neotools files write intro.txt intro
        ```
        
        Inspect applets and manage their settings
        ```bash
        > neotools applets list
        [
          {
            "name": "System",
            "applet_id": 0,
            "rom_size": 401408,
            ...
          },
        ...
        ```
        
        ```bash
        > neotools applets get-settings 0
        [
          {
            "label": "Auto Repeat (16385)",
            "ident": 16385,
            "type": "OPTION",
            "value": {
              "selected": "On (4097)",
              "options": [
                "On (4097)",
                "Off (4098)"
              ]
            }
          },
        ...
        ```
        Update system applet settings. Set idle time to five minutes.
        ```bash
        > neotools --verbose applets set-settings 0 16388 5 4 59
        ```
        
        
        
        ## Installation
        
        Confirm that you have Python 3 on your machine. Install neotools from the Python package repository with:
        `pip3 install neotools`.
        
        ## Troubleshooting
        
        ### Access denied
        `usb.core.USBError: [Errno 13] Access denied (insufficient permissions)`  
        A simple way to fix it is to run the command with `sudo`. However, it is
        better to give granular udev permissions to neotools. Add the following rule to 
        the udev rules, into, for example `/lib/udev/rules.d/50-alphasmart.rules`.
        ```
        ACTION=="add", SUBSYSTEMS=="usb", ATTRS{idVendor}=="081e", ATTRS{idProduct}=="bd01", MODE="660", GROUP="plugdev"
        ACTION=="add", SUBSYSTEMS=="usb", ATTRS{idVendor}=="081e", ATTRS{idProduct}=="bd04", MODE="660", GROUP="plugdev"
        ```
        Make sure that your user is a member of the `plugdev` group.
        
Platform: unix
Platform: linux
Platform: osx
Platform: cygwin
Platform: win32
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.4
Description-Content-Type: text/markdown
Provides-Extra: testing
