LEADS: Lightweight Embedded Assisted Driving System

LEADS is a system designed for VeC.

LEADS only supports two drive-wheel configurations: single rear wheel (SRW) mode and dual rear wheel (DRW) mode.

Python is generally not the best choice for writing embedded systems. We made this decision for the following reasons.

Data analysis
Short development cycle
Official support for Raspberry Pi
Low difficulty in getting started for team members

This project aims to implement the following functions:

A basic instrumentation system
A basic communication system
A basic control system
A data recording system with the following components
- A speed recording system
- A G force recording system
- A GPS recording system
- A battery voltage recording system
A control system with the following components
- DTCS (Dynamic Traction Control System)
- ABS (Anti-lock Braking System)
- EBI (Emergency Braking Intervention)
- ATBS (Automatic Trail Braking System)

Installation

Note that LEADS requires Python >= 3.11.

pip install pysimplegui keyboard pyserial leads

numpy will be automatically installed with leads.

pysimplegui, keyboard, and pyserial are optional.

If you need only the skeleton, run the following.

pip install leads

Quickstart

Main

python -m leads_vec

Optional Arguments

Configuration File

python -m leads_vec -c path/to/the/config/file

If not specified, all configurations will be default values.

To learn about the configuration file, read Configurations.

Configurations

	Type	Usage	Used By	Default
`srw_mode`	`bool`	`True`: single rear wheel; `False`: dual rear wheel	Main, Remote	`True`
`width`	`int`	Window width	Main	`720`
`height`	`int`	Window height	Main	`480`
`fullscreen`	`bool`	`True`: auto maximize; `False`: window mode	Main	`False`
`refresh_rate`	`int`	GUI frame per second	Main	`30`
`font_size_small`	`int`	Small font size	Main	`8`
`font_size_medium`	`int`	Medium font size	Main	`16`
`font_size_large`	`int`	Large font size	Main	`32`
`font_size_x_large`	`int`	Extra large font size	Main	`48`
`scaling_factor`	`float`	A factor used to scale every component	Main	`1`
`comm_addr`	`str`	Communication server address	Main	`"127.0.0.1"`
`comm_port`	`int`	The port on which the communication system runs on	Main, Remote	`16900`
`data_dir`	`str`	The directory for the data recording system	Remote	`"./data"`

Periodic Report

See reports.

Collaborations

Community

Issues

Our team management completely relies on GitHub. Tasks are published and assigned as issues. You will be notified if you are assigned to certain tasks. However, you may also choose to join other discussions for which you are not responsible.

There are a few labels that classify the issues.

bug reports a bug
code review discusses a code review or comment
documentation suggests a documentation enhancement
duplicate marks that a similar issue has been raised
enhancement proposes a new feature or request
help wanted means that extra attention is needed to this issue
invalid marks that the issue is in valid format
question requests further information
report starts a periodic report discussion
todo creates a new task
wontfix marks that the issue is ignored

Label your issue with at least one of the labels above before you submit.

Projects

You can have a look on the whole schedule of each project in timeline using the projects feature.

Code Contributions

Please fork the project into your own repository. Before your pull request, make sure that you have tested all possible impacts on other parts of the project. If no certainty is assured, please reach out to our core team members to have official supports.

Code Specifications

All code must be type-annotated and follow the Code Style Guide.

Metadata

Release files for leads 0.1.8

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for leads 0.1.8
File	Size	Uploaded
leads-0.1.8.tar.gz	21.8 kB	Dec 30, 2023	Details

Built distribution (wheel)

Table of built distributions (wheels) for leads 0.1.8
File	Interpreter	ABI	Platform	Reset
leads-0.1.8-py3-none-any.whl 27.6 kB Dec 30, 2023	Python 3	none	any	Details

Total release size: 49.4 kB

Release files / leads-0.1.8.tar.gz

Download URL	leads-0.1.8.tar.gz
Size	21.8 kB
Tags	Source
SHA-256 checksum How to use checksums	`d736a37b7c435fdda0b81e31649ce3c4649b19044d3312493641b60a33ba2b07`
BLAKE2b-256 checksum How to use checksums	`aea9620c5140910d333f0521c8aded5874efc50a26f8a010225dad4bd3cc00e2`
Upload date	Dec 30, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.9.18`

Release files / leads-0.1.8-py3-none-any.whl

Download URL	leads-0.1.8-py3-none-any.whl
Size	27.6 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`4da1a8660de281aad5b594b596bd4e4cc9d2dfe37d47047dd12904daf870490a`
BLAKE2b-256 checksum How to use checksums	`ed8051fd7422511e4403dc0d7c8f3f461a11391378e0b625a69d2fe0f34dc186`
Upload date	Dec 30, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.9.18`