Metadata-Version: 2.4
Name: xscope-fileio
Version: 1.3.1
Summary: Python module for managing files using xscope
Project-URL: Homepage, https://github.com/xmos/xscope_fileio
Author: XMOS
License: :orphan:
        
        xscope_fileio: FileIO over Xscope
        #################################
        
        :vendor: XMOS
        :version: 1.3.1
        :scope: General Use
        :description: FileIO library over xscope
        :category: Filesystem
        :keywords: stdio, fileio, xscope, xscope_fileio
        :devices: xcore.ai, xcore-200
        
        *******
        Summary
        *******
        
        Provides a fast method for reading and writing files between an ``xcore.ai`` device and a host computer. 
        It uses ``xscope`` to communicate between the two devices.
        
        ********
        Features
        ********
        
        * Device and host FileIO library over xscope. 
        * Python module for seamless integration and execution of firmware.
        * 6MB/s Device to Host speed (vs 2KB/s for stdio).
        * 1MB/s Host to Device speed (vs 1KB/s for stdio).
        * Application for loopback testing on Simulator or Hardware.
        
        ************
        Known issues
        ************
        
        * Missing the following stdio functions: ``fprintf`` , ``fscanf``. 
        * Byte only access: ``wb`` or ``rb`` file access mode only.
        
        ****************
        Development repo
        ****************
        
        * `xscope_fileio Repository <https://www.github.com/xmos/xscope_fileio>`_.
        
        *************
        Documentation
        *************
        
        * XMOS Libraries : `XMOS Website <https://www.xmos.com/libraries>`_.
        * Documentation source : `xscope_fileio Doc Source <https://github.com/xmos/xscope_fileio/tree/master/doc>`_.
        
        **************
        Required tools
        **************
        
        * XMOS XTC Tools: 15.3.1
        * Python: 3.10 or later
        * CMake: 3.23 or later
        
        *********************************
        Required libraries (dependencies)
        *********************************
        
        * None
        
        *************************
        Related application notes
        *************************
        
        * None
        
        *******
        Support
        *******
        
        This package is supported by XMOS Ltd. Issues can be raised against the software at: http://www.xmos.com/support
License-File: LICENSE.rst
Requires-Python: >=3.9
Description-Content-Type: text/x-rst

:orphan:

xscope_fileio: FileIO over Xscope
#################################

:vendor: XMOS
:version: 1.3.1
:scope: General Use
:description: FileIO library over xscope
:category: Filesystem
:keywords: stdio, fileio, xscope, xscope_fileio
:devices: xcore.ai, xcore-200

*******
Summary
*******

Provides a fast method for reading and writing files between an ``xcore.ai`` device and a host computer. 
It uses ``xscope`` to communicate between the two devices.

********
Features
********

* Device and host FileIO library over xscope. 
* Python module for seamless integration and execution of firmware.
* 6MB/s Device to Host speed (vs 2KB/s for stdio).
* 1MB/s Host to Device speed (vs 1KB/s for stdio).
* Application for loopback testing on Simulator or Hardware.

************
Known issues
************

* Missing the following stdio functions: ``fprintf`` , ``fscanf``. 
* Byte only access: ``wb`` or ``rb`` file access mode only.

****************
Development repo
****************

* `xscope_fileio Repository <https://www.github.com/xmos/xscope_fileio>`_.

*************
Documentation
*************

* XMOS Libraries : `XMOS Website <https://www.xmos.com/libraries>`_.
* Documentation source : `xscope_fileio Doc Source <https://github.com/xmos/xscope_fileio/tree/master/doc>`_.

**************
Required tools
**************

* XMOS XTC Tools: 15.3.1
* Python: 3.10 or later
* CMake: 3.23 or later

*********************************
Required libraries (dependencies)
*********************************

* None

*************************
Related application notes
*************************

* None

*******
Support
*******

This package is supported by XMOS Ltd. Issues can be raised against the software at: http://www.xmos.com/support
