Skip to content

Repository files navigation

Python PLIN library

This library provides a Python interface for interacting with PEAK devices such as the PCAN-USB Pro and PLIN-USB on Linux using the chardev API provided by the PEAK LIN Linux Driver. The PEAK LIN Linux driver is required to use this library and is available here.

Installation

The plin-linux package is available on PyPI and can be directly installed with pip install plin-linux.

Examples

Runnable examples are located in the examples/ directory.

Master Example

fromplin.deviceimportPLINfromplin.enumsimport (PLINFrameChecksumType, PLINFrameDirection,
PLINFrameFlag, PLINMode)
# Initializes /dev/plin0 as a LIN mastermaster=PLIN(interface="/dev/plin0")
master.start(mode=PLINMode.MASTER, baudrate=19200)
# Get firmware version of the PEAK deviceprint(master.get_firmware_version())
# Get current status of the PEAK deviceprint(master.get_status())
# Add a publisher frame entrymaster.set_frame_entry(id=0x22,
direction=PLINFrameDirection.PUBLISHER,
checksum_type=PLINFrameChecksumType.CLASSIC,
data=bytearray([0x01, 0x02, 0x03, 0x04]))
# Add a subscriber frame entrymaster.set_frame_entry(id=0x23,
direction=PLINFrameDirection.SUBSCRIBER_AUTO_LEN,
checksum_type=PLINFrameChecksumType.CLASSIC)
# Get frame entryprint(master.get_frame_entry(id=0x22))
# Add unconditional slot to schedule 0master.add_unconditional_schedule_slot(schedule=0, delay_ms=10, id=0x22)
master.add_unconditional_schedule_slot(schedule=0, delay_ms=10, id=0x23)
# Get schedule 0 slotsprint(master.get_schedule_slots(0))
# Start schedule 0master.start_schedule(0)
# Set ID filtermaster.set_id_filter(bytearray([0xff] *8))
# Read frameswhileTrue:
result=master.read()
print(result)

Slave Example

fromplin.deviceimportPLINfromplin.enumsimportPLINMode# Initializes /dev/plin0 as a LIN slaveslave=PLIN(interface="/dev/plin0")
slave.start(mode=PLINMode.SLAVE, baudrate=19200)
# Set ID filterslave.set_id_filter(bytearray([0xff] *8))
# Read frameswhileTrue:
result=slave.read()
print(result)

Unit Tests

  • Unit tests are located in the unit_tests/ directory.
  • Tests in unit_tests/integration/ require a PEAK LIN device connected to run.
  • Can be run with pytest.

License

Copyright 2024 Rivian Automotive, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

About

The python-plin package is a Python wrapper for the chardev API provided by the PEAK LIN Linux Driver.

Topics

Resources

Stars

8 stars

Watchers

5 watching

Forks

Releases

Packages

Used by

Contributors

Languages