Differences

This shows you the differences between two versions of the page.

--- blog:car_stuff_pycosworth [2021/08/18 10:15] – [Normal Interface] john
+++ blog:car_stuff_pycosworth [2021/08/18 16:04] (current) – [Software Requirements] john
@@ Line 4: / Line 4: @@
 **PyCosworth** is a monitoring, data-logging and diagnostic tool for (primarily Escort/Sierra Cosworth) vehicles equipped with the [[http://www.bigturbo.co.uk|Magneti Marelli L8/P8 ECU]] which have the serial datastream protocol enabled.
+Quick Links:
+   * General overview, Hardware & Software requirements - //keep reading this page//
+   * [[blog:car_stuff_pycosworth_hardware|Example hardware setup]]
+   * [[blog:car_stuff_pycosworth_configuration|Configuring the software]]
+   * [[blog:car_stuff_pycosworth_raspbian|Configuring a Raspberry Pi for PyCosworth]]
+   * [[blog:car_stuff_pycosworth_pectel|Pectel serial datastream documentation]]
 {{:blog:pycosworth:ford-cosworth-yb-turbo-engine.jpg?400|}}
@@ Line 20: / Line 27: @@
 ===== Hardware Requirements =====
+In addition to my software, you need a few key pieces of hardware in order to access the sensor data from your Cosworth ECU:
    * **A vehicle with a //serial datastream enabled// Magneti Marelli ECU**, specifically:
@@ Line 40: / Line 49: @@
     * Button 3: Restart ECU comms
-   * **Optionally:** //A SSH1102 or SSD1306 miniature OLED screen// supported by the Python [luma.oled driver](https://luma-oled.readthedocs.io/en/latest/) (the 1.3" screens with 128x64 pixels are strongly reccomended) for __in-car__ live sensor/data visualisation.
+   * **Optionally:** //A SSH1102 or SSD1306 miniature OLED screen// supported by the Python [[https://luma-oled.readthedocs.io/en/latest/|luma.oled driver]] (the 1.3" screens with 128x64 pixels are strongly reccomended) for __in-car__ live sensor/data visualisation.
    * **Optionally:** //A supported X11 display or desktop interface// to emulate the live sensor/data visualisation as would be seen in the OLED screens, in a desktop window.
-  * **Optionally:** //A Super Watchdog V2// watchdog/UPS hat addon for the Raspberry Pi in order to handle random power-off events whilst using the system in a car, and to shut the system down safely when the ignition power is disconnected.
+  * **Optionally:** //A [[https://sequentmicrosystems.com/products/raspberry-pi-battery-backup|Super Watchdog V2]]// watchdog/UPS hat addon for the Raspberry Pi in order to handle random power-off events whilst using the system in a car, and to shut the system down safely when the ignition power is disconnected.
-   * **Optionally:** //An AEM Wideband X-Series Air Fuel Ratio sensor// and gauge with serial datastream output. You will need a secondary USB to RS232 adapter for the AEM sensor/gauge.
+   * **Optionally:** //An [[https://www.aemelectronics.com/products/gauges/digital-gauges/x-series-wideband-uego-afr-sensor-controller-gauge|AEM Wideband X-Series Air Fuel Ratio sensor]]// and gauge with serial datastream output. You will need a secondary USB to RS232 adapter for the AEM sensor/gauge.
-   * **Optionally:** //A Digispark ATiny85 USB development board// running the I2C-tiny-usb firmware to connect and prototype I2C connected OLED screens on a desktop PC. This is for development of the UI on OLED devices when not using a Raspberry Pi (laptops/desktops do not normally have a user-accessible I2C interface. It is __not__ needed to run the software normally.
+   * **Optionally:** //A [[http://digistump.com/products/1|Digispark ATiny85 USB development board]]// running the [[https://github.com/harbaum/I2C-Tiny-USB/tree/master/digispark|I2C-tiny-usb firmware]] to connect and prototype I2C connected OLED screens on a desktop PC. This is for development of the UI on OLED devices when not using a Raspberry Pi (laptops/desktops do not normally have a user-accessible I2C interface. It is __not__ needed to run the software normally.
 {{:blog:pycosworth:l8ecu.gif?}} {{:blog:pycosworth:p8ecu.jpg?}} {{:blog:pycosworth:laptop.jpg?}} {{:blog:pycosworth:pi3.jpg?}} {{:blog:pycosworth:ssd1306.jpg?}} {{:blog:pycosworth:aem.jpg?}}
@@ Line 56: / Line 65: @@
 The addition of an AEM Wideband sensor and gauge makes it possible to simultaneously log AFR data at the same time as the main Cosworth ECU sensors. If you have another device that you wish to add support for, please let me know.
-It it not designed to work (and I have no way to test) on the Fiat/Lancia or *Ferrari F40!* version of the ECU, but *may* work. However, an [[http://www.nailed-barnacle.co.uk/coupe/startrek/startrek.html|excellent tool already exists]], that the comms protocol part of PyCosworth is partly based on. Many thanks to Neil, the author of that tool, for his technical information.
+It it not designed to work (and I have no way to test) on the Fiat/Lancia or Ferrari F40 version of the Magneti Marelli ECU, but //may// work. However, an [[http://www.nailed-barnacle.co.uk/coupe/startrek/startrek.html|excellent tool already exists]], that the comms protocol part of PyCosworth is partly based on. Many thanks to Neil, the author of that tool, for his technical information.
 ==== Hardware Configuration Guide ====
-There are too many variables to say //"this is exactly how to do it"//, but I've documented how **my** setup is connected together in this guide....
+There are too many variables to say //"this is exactly how to do it"//, but I've documented how **my** setup is connected together in [[blog:car_stuff_pycosworth_hardware|this hardware setup guide]].
 ===== Software Requirements =====
-All of the **Python** software library requirements are listed in the *requirements.txt* file, simply run:
+All of the **Python** software library requirements are listed in the //requirements.txt// file, simply run:
 <code>
@@ Line 86: / Line 95: @@
 After initialisation is complete, the application will immediately move to the first defined sensor that is set in the [the configuration file](docs/Configuration.md).
-You can cycle through the available Cosworth sensors (*AMAL* valve duty cycle, *ECT*: Engine Coolant Temperature, *IAT*: Intake Air Temperature, *INJDUR*: Injector Pulse Width Duration, *BAT*: Battery voltage, *CO*: Base Fuelling, *IGNADV*: Ignition Advance, *TPS*: Throttle Position, *MAP*: Manifold Pressure and *RPM*) with a single press of **Button 2** at any time. In addition *AFR* is available if you have enabled the AEM Wideband sensor support.
+You can cycle through the available Cosworth sensors:
+   * **AMAL** valve duty cycle, in percent
+   * **BAT** Battery voltage
+   * **CO** Base Fuelling, in percentage increase over base level
+   * **ECT** Engine Coolant Temperature, in degrees centigrade
+   * **IAT** Intake Air Temperature, in degrees centigrade
+   * **IGNADV** Ignition Advance, in degrees
+   * **INJDUR** Injector Pulse Width Duration, in milliseconds
+   * **MAP** Manifold Pressure, in millibars (or PSI, if configured via settings)
+   * **RPM**
+   * **TPS** Throttle Position, in percentage open
+... with a single press of **Button 2** at any time. In addition **AFR** is available if you have enabled the AEM Wideband sensor support. The current sensor is highlighted in the upper left corner of the display.
 {{:blog:pycosworth:oled_1.jpg?}} {{:blog:pycosworth:oled_2.jpg?}}
@@ Line 98: / Line 120: @@
 You can press **Button 3** to re-establish communication links with the supported sensors (Cosworth ECU and AEM Wideband AFR) without powering the device off. Whilst comms are being restarted a wait message will be shown on-screen.
-![Start up](docs/oled_3.jpg) ![Start up](docs/oled_4.jpg)
+{{:blog:pycosworth:oled_3.jpg?}} !{{:blog:pycosworth:oled_4.jpg?}}
-==== Additional Functions ====
+==== Datalogging & Demo Functions ====
-You can access a demo mode to test your hardware by running the application in *Demo Sensor* mode - this generates a never-ending stream of bogus sensor data for each of the sensors you have activated. **Demo Mode** is indicated by the status display in the top right corner of the screen.
+You can access a demo mode to test your hardware by running the application in //demo sensor// mode (see the link to the configuration file, below) - this generates a never-ending stream of bogus sensor data for each of the sensors you have activated. **Demo Mode** is indicated by the status display in the top right corner of the screen.
-In addition, you can start or stop logging at any point in time by pressing **Button 1** and a log of the active sensors will be recorded to disk/SD card. **Logging Mode** is indicated by the status display in the bottom right corner of the screen.
+In addition, you can start or stop //logging// at any point in time by pressing **Button 1** and a log of the active sensors will be recorded to disk/SD card. **Logging Mode** is indicated by the status display in the bottom right corner of the screen.
-![OLED Demo Mode](docs/oled_5.jpg) ![OLED Logging](docs/oled_6.jpg)
+{{:blog:pycosworth:oled_5.jpg?}} {{:blog:pycosworth:oled_6.jpg?}}
 The file that the sensor data is recorded to is an industry standard comma-seperated-value text file:
-![CSV Example](docs/csv.jpg)
+{{:blog:pycosworth:csv.jpg?}}
-The *Counter* column is the sensor-reading pass that recorded the data. From the point at which the ECU is connected, the data is continually sampled; each pass having a unique ID for the duration that the device is powered on.
+The **Counter** column is the sensor-reading pass that recorded the data. From the point at which the ECU is connected, the data is continually sampled; each pass having a unique ID for the duration that the device is powered on.
-The *Time* column is the time relative to the first sensor reading. Since the Raspberry Pi and other similar embedded devices do not have clocks, there is no guarantee we can use a HH:MM:SS format, so we record each log of sensor readings as an offset (in seconds) from the first reading.
+The **Time** column is the time relative to the first sensor reading. Since the Raspberry Pi and other similar embedded devices do not have clocks, there is no guarantee we can use a HH:MM:SS format, so we record each log of sensor readings as an offset (in seconds) from the first reading.
 ===== Configuration =====
-All of the user-customisable settings are found in the file `libs/settings.py`. This includes an extensive set of optional modules and complete customisation over which sensors are monitored, their update frequency (subject to the speed of the ECU) as well as total control over the layout and display modes of the in-car visualisation and display options.
+All of the user-customisable settings are found in the file <code>libs/settings.py</code> within the programme directory. This includes an extensive set of optional modules and complete customisation over which sensors are monitored, their update frequency (subject to the speed of the ECU) as well as total control over the layout and display modes of the in-car visualisation and display options.
-Please see [the configuration guide](docs/Configuration.md) for full details.
+Please see [[:blog:car_stuff_pycosworth_configuration|the configuration guide]] for full details.
 ----
@@ Line 126: / Line 148: @@
 ===== Pectel Datastream =====
-For full details of the Pectel serial datastream, see [the Cosworth Pectel datastream protocol](docs/Pectel.md) document.
+For full details of the Pectel serial datastream that I have found, see [[:blog:car_stuff_pycosworth_pectel|the Cosworth Pectel datastream protocol]] document.