Skip to content

Commit

Permalink
V3.0.0 - Support of UDS, tasks and other enhancements (#11)
Browse files Browse the repository at this point in the history
V3.0.0 features:

- Large code refactoring
- Better commenting
- Documentation updated
- Support of Tasks and plugins
- Support of ATCRA, ATCAF0, ATCAF1, ATSW and many other commands
- Set ATE1 as default
- Addition of "test" command and many other commands
- Addition of a number of special setters
- Added the response processing function to support the XML format (see process_response())
- Support of UDS
- Add "commands"
- Add security note
- Add CONTRIBUTING
- Added task samples in plugins directory
- Revised MANIFEST.in
- Initial mt05 support
- Added new tag pos_answer and neg_answer
- Added nested tasks
- Management of shared namespace
- Manage input multiframe
- Implement UDS multiline output
- Implement UDS routines
- Completed MT05 Firmware Upload/Download tasks
- Added EQU Tasks
- Added ISO-TP
- Added UDS timers
- Revision of colors and autocompletion with Windows.
- Using pyreadline3 instead of tendo
- Improved loglevel command argument handling
  • Loading branch information
Ircama authored Jun 12, 2021
1 parent 62e2550 commit bf8100a
Show file tree
Hide file tree
Showing 20 changed files with 4,432 additions and 916 deletions.
62 changes: 62 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# ELM327-emulator contribution guidelines

Contributions might involve:

- Adding new core features
- Adding a new plugin in the plugin directory
- Providing a new dictionary file for a specific EQU or vehicle
- Updating or adding pids/data in obd_message.py
- Updating or adding AT messages in obd_message.py

In all these cases, we operate the "Fork & Pull" model explained at

https://help.github.com/articles/about-pull-requests/

First contributors can follow a [tutorial page](https://github.com/firstcontributions/first-contributions).

Please discuss the change you wish to make via an [issue](https://github.com/Ircama/ELM327-emulator/issues) before developing a pull request.

# Bugs

You can help to report bugs by filing an [issue](https://github.com/Ircama/ELM327-emulator/issues) on the software or on the documentation.

# Code of Conduct

### Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of experience,
nationality, personal appearance, race, religion, or sexual identity and
orientation.

### Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of improper language
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting

### Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.
3 changes: 2 additions & 1 deletion MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
include elm/*.yaml
include elm/*.yaml
recursive-include elm/plugins task_*.py
850 changes: 712 additions & 138 deletions README.md

Large diffs are not rendered by default.

4 changes: 3 additions & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ it is important to revise any third-party customization to avoid that security f
Security bugs will be taken seriously and,
if confirmed upon investigation, a new patch will be released within a reasonable amount of time, including a security bulletin and the credit to the discoverer.

Warning: when using the TCP/IP networking, the INET socket is bound to all interfaces.

## Reporting a Security Bug

The way to report a security bug is to open an [issue](https://github.com/Ircama/ELM327-emulator/issues) including related information
(e.g., reproduction steps, version).
(e.g., reproduction steps, version).
2 changes: 1 addition & 1 deletion elm/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,5 @@
map(str, sys.version_info[:3])) + ".")
sys.exit(1)

from .elm import Elm
from .elm import Elm, Tasks, EcuTasks
from .interpreter import main
2 changes: 1 addition & 1 deletion elm/__version__.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = '2.1.1'
__version__ = '3.0.0'
Loading

0 comments on commit bf8100a

Please sign in to comment.