From a76a6412874095e29bd9a1a121e2707140d8a2e1 Mon Sep 17 00:00:00 2001 From: jkerdreu <jkerdreu@b32b6428-25c9-4566-ad07-03861ab6144f> Date: Tue, 16 Jul 2024 12:01:55 +0000 Subject: [PATCH] Fix docs git-svn-id: https://redmine.imt-atlantique.fr/svn/xaal/code/Python/branches/0.7@3204 b32b6428-25c9-4566-ad07-03861ab6144f --- devices/protocols/IPX-800/README.rst | 24 +++++++++--------------- devices/protocols/IPX-800/pyproject.toml | 12 ++++++++---- 2 files changed, 17 insertions(+), 19 deletions(-) diff --git a/devices/protocols/IPX-800/README.rst b/devices/protocols/IPX-800/README.rst index ba7eb540..d4a7b3df 100644 --- a/devices/protocols/IPX-800/README.rst +++ b/devices/protocols/IPX-800/README.rst @@ -1,24 +1,18 @@ xaal.ipx800 =========== This package contains a xAAL gateway for IPX-800 Ethernet Control System. +We tested it with IPX-800 V3. -Install -======= -You can use both pip, with pip install xaal.ipx800 or setup.py - -You can test the package with : -python setup.py develop (or install) --user - +Usage +----- To run the gateway: -- edit your config file (~/.xaal/xaal.ipx800.ini) -- launch python -m xaal.ipx800 +- edit your config file (*ipx800.ini*) +- launch *python -m xaal.ipx800* -TODO -==== -Due to time constraint, only channel outputs (relays) are -supported right now. You can add easily analog or digital -inputs, everything is ready. -Perhaps, in future. +TODO +---- +Due to time constraint, only channel outputs (relays) are supported right now. +You can add easily analog or digital inputs, everything is ready. diff --git a/devices/protocols/IPX-800/pyproject.toml b/devices/protocols/IPX-800/pyproject.toml index f6e7f9a8..332bc1f8 100644 --- a/devices/protocols/IPX-800/pyproject.toml +++ b/devices/protocols/IPX-800/pyproject.toml @@ -3,10 +3,14 @@ name = "xaal.ipx800" version = "0.1" description = "xAAL devices for IPX-800 Ethernet Control System" readme = "README.rst" -authors = [ { name = "Jerome Kerdreux", email = "Jerome.Kerdreux@imt-atlantique.fr" } ] -license = { text = "GPL License"} -classifiers = ["Programming Language :: Python", -"Topic :: Software Development :: Libraries :: Python Modules"] +authors = [ + { name = "Jerome Kerdreux", email = "Jerome.Kerdreux@imt-atlantique.fr" }, +] +license = { text = "GPL License" } +classifiers = [ + "Programming Language :: Python", + "Topic :: Software Development :: Libraries :: Python Modules", +] keywords = ["xaal", "ipx-800"] dependencies = ["xaal.lib", "gevent"] -- GitLab