Skip to content

Commit

Permalink
renaming and first implementaiton of seatcupra features
Browse files Browse the repository at this point in the history
  • Loading branch information
tillsteinbach committed Feb 22, 2025
1 parent b394e91 commit b514bc9
Show file tree
Hide file tree
Showing 18 changed files with 812 additions and 482 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/build_and_publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ jobs:
runs-on: ubuntu-latest
environment:
name: pypi
url: https://pypi.org/p/carconnectivity-connector-cupra
url: https://pypi.org/p/carconnectivity-connector-seatcupra
permissions:
id-token: write

Expand Down
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ All notable changes to this project will be documented in this file.
## [0.1] - XXXX-XX-XX
Initial release, let's go and give this to the public to try out...

[unreleased]: https://github.com/tillsteinbach/CarConnectivity-connector-cupra/compare/v0.1...HEAD
[0.1]: https://github.com/tillsteinbach/CarConnectivity-connector-cupra/releases/tag/v0.1
[unreleased]: https://github.com/tillsteinbach/CarConnectivity-connector-seatcupra/compare/v0.1...HEAD
[0.1]: https://github.com/tillsteinbach/CarConnectivity-connector-seatcupra/releases/tag/v0.1
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@


# CarConnectivity Connector for Cupra Vehicles
[![GitHub sourcecode](https://img.shields.io/badge/Source-GitHub-green)](https://github.com/tillsteinbach/CarConnectivity-connector-cupra/)
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/tillsteinbach/CarConnectivity-connector-cupra)](https://github.com/tillsteinbach/CarConnectivity-connector-cupra/releases/latest)
[![GitHub](https://img.shields.io/github/license/tillsteinbach/CarConnectivity-connector-cupra)](https://github.com/tillsteinbach/CarConnectivity-connector-cupra/blob/master/LICENSE)
[![GitHub issues](https://img.shields.io/github/issues/tillsteinbach/CarConnectivity-connector-cupra)](https://github.com/tillsteinbach/CarConnectivity-connector-cupra/issues)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/carconnectivity-connector-cupra?label=PyPI%20Downloads)](https://pypi.org/project/carconnectivity-connector-cupra/)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/carconnectivity-connector-cupra)](https://pypi.org/project/carconnectivity-connector-cupra/)
# CarConnectivity Connector for Seat and Cupra Vehicles
[![GitHub sourcecode](https://img.shields.io/badge/Source-GitHub-green)](https://github.com/tillsteinbach/CarConnectivity-connector-seatcupra/)
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/tillsteinbach/CarConnectivity-connector-seatcupra)](https://github.com/tillsteinbach/CarConnectivity-connector-seatcupra/releases/latest)
[![GitHub](https://img.shields.io/github/license/tillsteinbach/CarConnectivity-connector-seatcupra)](https://github.com/tillsteinbach/CarConnectivity-connector-seatcupra/blob/master/LICENSE)
[![GitHub issues](https://img.shields.io/github/issues/tillsteinbach/CarConnectivity-connector-seatcupra)](https://github.com/tillsteinbach/CarConnectivity-connector-seatcupra/issues)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/carconnectivity-connector-seatcupra?label=PyPI%20Downloads)](https://pypi.org/project/carconnectivity-connector-seatcupra/)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/carconnectivity-connector-seatcupra)](https://pypi.org/project/carconnectivity-connector-seatcupra/)
[![Donate at PayPal](https://img.shields.io/badge/Donate-PayPal-2997d8)](https://www.paypal.com/donate?hosted_button_id=2BVFF5GJ9SXAJ)
[![Sponsor at Github](https://img.shields.io/badge/Sponsor-GitHub-28a745)](https://github.com/sponsors/tillsteinbach)


## Due to lack of access to a Cupra car the development of this conenctor is currently stuck. If you want to help me with access to your account, please contact me!

[CarConnectivity](https://github.com/tillsteinbach/CarConnectivity) is a python API to connect to various car services. This connector enables the integration of cupra vehicles through the MyCupra API. Look at [CarConnectivity](https://github.com/tillsteinbach/CarConnectivity) for other supported brands.
[CarConnectivity](https://github.com/tillsteinbach/CarConnectivity) is a python API to connect to various car services. This connector enables the integration of seat and cupra vehicles through the MyCupra API. Look at [CarConnectivity](https://github.com/tillsteinbach/CarConnectivity) for other supported brands.

## Configuration
In your carconnectivity.json configuration add a section for the cupra connector like this:
In your carconnectivity.json configuration add a section for the seatcupra connector like this:
```
{
"carConnectivity": {
"connectors": [
{
"type": "cupra",
"type": "seatcupra",
"config": {
"username": "test@test.de",
"password": "testpassword123"
Expand All @@ -36,7 +36,7 @@ In your carconnectivity.json configuration add a section for the cupra connector
If you do not want to provide your username or password inside the configuration you have to create a ".netrc" file at the appropriate location (usually this is your home folder):
```
# For MyCupra
machine cupra
machine seatcupra
login test@test.de
password testpassword123
```
Expand All @@ -46,7 +46,7 @@ In this case the configuration needs to look like this:
"carConnectivity": {
"connectors": [
{
"type": "cupra",
"type": "seatcupra",
"config": {
}
}
Expand All @@ -61,7 +61,7 @@ You can also provide the location of the netrc file in the configuration.
"carConnectivity": {
"connectors": [
{
"type": "cupra",
"type": "seatcupra",
"config": {
"netrc": "/some/path/on/your/filesystem"
}
Expand All @@ -73,7 +73,7 @@ You can also provide the location of the netrc file in the configuration.
The optional S-PIN needed for some commands can be provided in the account section of the netrc:
```
# For MyCupra
machine cupra
machine seatcupra
login test@test.de
password testpassword123
account 1234
Expand Down
12 changes: 6 additions & 6 deletions doc/Config.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@


# CarConnectivity Connector for Cupra Config Options
# CarConnectivity Connector for Seat Cupra Config Options
The configuration for CarConnectivity is a .json file.
## Cupra Connector Options
These are the valid options for the Cupra Connector
## Seat Cupra Connector Options
These are the valid options for the Seat Cupra Connector
```json
{
"carConnectivity": {
"connectors": [
{
"type": "cupra", // Definition for the Cupra Connector
"type": "seatcupra", // Definition for the Seat Cupra Connector
"config": {
"log_level": "error", // set the connectos log level
"interval": 300, // Interval in which the server is checked in seconds
"username": "test@test.de", // Username of your Cupra Account
"password": "testpassword123", // Username of your Cupra Account
"username": "test@test.de", // Username of your Seat/Cupra Account
"password": "testpassword123", // Username of your Seat/Cupra Account
"spin": 1234, //S-Pin used for some special commands like locking/unlocking
"netrc": "~/.netr", // netrc file if to be used for passwords
"api_log_level": "debug", // Show debug information regarding the API
Expand Down
6 changes: 3 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ requires = [
build-backend = "setuptools.build_meta"

[project]
name = "carconnectivity-connector-cupra"
description = "CarConnectivity connector for Cupra services"
name = "carconnectivity-connector-seatcupra"
description = "CarConnectivity connector for Seat and Cupra services"
dynamic = ["version"]
requires-python = ">=3.9"
authors = [
Expand Down Expand Up @@ -36,7 +36,7 @@ classifiers = [
[project.urls]

[tool.setuptools_scm]
write_to = "src/carconnectivity_connectors/cupra/_version.py"
write_to = "src/carconnectivity_connectors/seatcupra/_version.py"

[tool.pylint.format]
max-line-length=160
Expand Down
Loading

0 comments on commit b514bc9

Please sign in to comment.