Skip to content

Add CAN and LIN database creation examples #219

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
epage merged 8 commits into from
Jan 26, 2018
Merged

Add CAN and LIN database creation examples #219

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
87436c7
chore: Add .mypy_cache folder to .gitignore
d-bohls Jan 26, 2018
f617740
docs: Fix tox integration command in CONTRIBUTING.rst
d-bohls Jan 26, 2018
e43b498
fix(examples): Fix typo in example comment
d-bohls Jan 22, 2018
b5c5f9a
fix(API): Use nxdb_get_property_size for db props
d-bohls Jan 22, 2018
57fb0cf
fix(API): `Db.cluster` should be `Db.clusters`
d-bohls Jan 22, 2018
855b783
fix(API): Change LinSchedEntry.frames to Frames
d-bohls Jan 22, 2018
02dac70
fix(API): Change type of Ecu.lin_protocol_ver
d-bohls Jan 22, 2018
024bacc
feat(examples): Add database creation examples
d-bohls Jan 22, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.cache/
.mypy_cache/
.tox/
junit/
__pycache__
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ To run the tests::
$ # Unit tests:
$ tox
$ # Integration tests:
$ tox -c tox-integration.ini -- --can-in-interface CAN1 --can-out-interface CAN2 --lin-in-interface LIN1 --lin-out-interface CAN2
$ tox -c tox-integration.ini -- --can-in-interface CAN1 --can-out-interface CAN2 --lin-in-interface LIN1 --lin-out-interface LIN2
$ # Integration tests (no LIN board):
$ tox -c tox-integration.ini -- --can-in-interface CAN1 --can-out-interface CAN2

Expand Down
1 change: 1 addition & 0 deletions docs/examples.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,4 @@ Examples
examples/conversion
examples/can_lin_diff
examples/programmatic_databases
examples/database_creation
18 changes: 18 additions & 0 deletions docs/examples/database_creation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
Database Creation Example
=========================

This example programmatically modifies the in-memory database to
contain a cluster, a frame, and two signals. The database is then
used in a :any:`nixnet.session.SignalOutSinglePointSession` and
:any:`nixnet.session.SignalInSinglePointSession` to write and then
read a pair of signals.

CAN Database Creation
---------------------

.. literalinclude:: ../../nixnet_examples/can_dynamic_database_creation.py

LIN Database Creation
---------------------

.. literalinclude:: ../../nixnet_examples/lin_dynamic_database_creation.py
10 changes: 5 additions & 5 deletions nixnet/_cprops.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -391,7 +391,7 @@ def set_database_u8(ref, prop_id, value):

def get_database_u8_array(ref, prop_id):
# type: (int, int) -> typing.Iterable[int]
value_size = _funcs.nx_get_property_size(ref, prop_id)
value_size = _funcs.nxdb_get_property_size(ref, prop_id)
elements = value_size // _ctypedefs.u8.BYTES

ref_ctypes = _ctypedefs.nxDatabaseRef_t(ref)
Expand Down Expand Up @@ -458,7 +458,7 @@ def set_database_u32(ref, prop_id, value):

def get_database_u32_array(ref, prop_id):
# type: (int, int) -> typing.Iterable[int]
value_size = _funcs.nx_get_property_size(ref, prop_id)
value_size = _funcs.nxdb_get_property_size(ref, prop_id)
elements = value_size // _ctypedefs.u32.BYTES

ref_ctypes = _ctypedefs.nxDatabaseRef_t(ref)
Expand Down Expand Up @@ -556,7 +556,7 @@ def set_database_f64(ref, prop_id, value):

def get_database_string(ref, prop_id):
# type: (int, int) -> typing.Text
value_size = _funcs.nx_get_property_size(ref, prop_id)
value_size = _funcs.nxdb_get_property_size(ref, prop_id)

ref_ctypes = _ctypedefs.nxDatabaseRef_t(ref)
prop_id_ctypes = _ctypedefs.u32(prop_id)
Expand Down Expand Up @@ -621,14 +621,14 @@ def set_database_ref(ref, prop_id, value):

def get_database_ref_array_len(ref, prop_id):
# type: (int, int) -> int
value_size = _funcs.nx_get_property_size(ref, prop_id)
value_size = _funcs.nxdb_get_property_size(ref, prop_id)
elements = value_size // _ctypedefs.nxDatabaseRef_t.BYTES
return elements


def get_database_ref_array(ref, prop_id):
# type: (int, int) -> typing.Iterable[int]
value_size = _funcs.nx_get_property_size(ref, prop_id)
value_size = _funcs.nxdb_get_property_size(ref, prop_id)
Copy link
Contributor

@epage epage Jan 22, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops, copy/paste bug on my part. Sorry you had to deal with it

elements = value_size // _ctypedefs.nxDatabaseRef_t.BYTES

ref_ctypes = _ctypedefs.nxDatabaseRef_t(ref)
Expand Down
8 changes: 8 additions & 0 deletions nixnet/_enums.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1539,6 +1539,14 @@ class LinLastErr(enum.Enum):
CRC = _cconsts.NX_LIN_LAST_ERR_CODE_CRC


class LinProtocolVer(enum.Enum):
VER_1_2 = _cconsts.NX_LIN_PROTOCOL_VER_1_2
VER_1_3 = _cconsts.NX_LIN_PROTOCOL_VER_1_3
VER_2_0 = _cconsts.NX_LIN_PROTOCOL_VER_2_0
VER_2_1 = _cconsts.NX_LIN_PROTOCOL_VER_2_1
VER_2_2 = _cconsts.NX_LIN_PROTOCOL_VER_2_2


class Condition(enum.Enum):
TRANSMIT_COMPLETE = _cconsts.NX_CONDITION_TRANSMIT_COMPLETE
INTF_COMMUNICATING = _cconsts.NX_CONDITION_INTF_COMMUNICATING
Expand Down
7 changes: 5 additions & 2 deletions nixnet/db/_ecu.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
from __future__ import print_function

from nixnet import _props
from nixnet import constants


class Ecu(object):
Expand Down Expand Up @@ -111,11 +112,13 @@ def lin_master(self, value):

@property
def lin_protocol_ver(self):
return _props.get_ecu_lin_protocol_ver(self._handle)
# type: () -> constants.LinProtocolVer
return constants.LinProtocolVer(_props.get_ecu_lin_protocol_ver(self._handle))

@lin_protocol_ver.setter
def lin_protocol_ver(self, value):
_props.set_ecu_lin_protocol_ver(self._handle, value)
# type: (constants.LinProtocolVer) -> None
_props.set_ecu_lin_protocol_ver(self._handle, value.value)

@property
def lin_initial_nad(self):
Expand Down
11 changes: 9 additions & 2 deletions nixnet/db/_linsched_entry.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,11 @@
from __future__ import division
from __future__ import print_function

import typing # NOQA: F401

from nixnet import _props
from nixnet import constants
from nixnet.db import _frame


class LinSchedEntry(object):
Expand Down Expand Up @@ -56,11 +59,15 @@ def event_id(self, value):

@property
def frames(self):
return _props.get_lin_sched_entry_frames(self._handle)
# type: () -> typing.Iterable[_frame.Frame]
Copy link
Contributor

@epage epage Jan 22, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From travis: nixnet/db/_linsched_entry.py:58: error: Name 'typing' is not defined

You need to import typing. See some of the other files for how to do it without causing flake8 problems

for ref in _props.get_lin_sched_entry_frames(self._handle):
yield _frame.Frame(ref)

@frames.setter
def frames(self, value):
_props.set_lin_sched_entry_frames(self._handle, value)
# type: (typing.Iterable[_frame.Frame]) -> None
Copy link
Contributor

@epage epage Jan 22, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ditto about mypy error from travis

frame_handles = [frame._handle for frame in value]
_props.set_lin_sched_entry_frames(self._handle, frame_handles)

@property
def name(self):
Expand Down
2 changes: 1 addition & 1 deletion nixnet/db/database.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ def name(self):
return _props.get_database_name(self._handle)

@property
def cluster(self):
def clusters(self):
return self._clusters

@property
Expand Down
87 changes: 87 additions & 0 deletions nixnet_examples/can_dynamic_database_creation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
from __future__ import absolute_import
from __future__ import division
from __future__ import print_function

from random import randint
import six
import time

import nixnet
from nixnet import constants
from nixnet import db


def main():
Copy link
Contributor

@epage epage Jan 22, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Each example

  • Should have a unit test
  • Should be included in the documentation

database_name = ':memory:'
cluster_name = 'CAN_Cluster'
frame_name = 'CAN_Event_Frame'
signal_1_name = 'CAN_Event_Signal_1'
signal_2_name = 'CAN_Event_Signal_2'
signal_list = [signal_1_name, signal_2_name]
output_interface = 'CAN1'
input_interface = 'CAN2'

# Open the default in-memory database.
with db.Database(database_name) as database:

# Add a CAN cluster, a frame, and two signals to the database.
cluster = database.clusters.add(cluster_name)
cluster.protocol = constants.Protocol.CAN
cluster.baud_rate = 125000
frame = cluster.frames.add(frame_name)
frame.id = 1
frame.payload_len = 2
signal_1 = frame.mux_static_signals.add(signal_1_name)
signal_1.byte_ordr = constants.SigByteOrdr.BIG_ENDIAN
signal_1.data_type = constants.SigDataType.UNSIGNED
signal_1.start_bit = 0
signal_1.num_bits = 8
signal_2 = frame.mux_static_signals.add(signal_2_name)
signal_2.byte_ordr = constants.SigByteOrdr.BIG_ENDIAN
signal_2.data_type = constants.SigDataType.UNSIGNED
signal_2.start_bit = 8
signal_2.num_bits = 8

# Use the database we just created, write and then read a pair of signals.
with nixnet.SignalOutSinglePointSession(
output_interface,
database_name,
cluster_name,
signal_list) as output_session:
with nixnet.SignalInSinglePointSession(
input_interface,
database_name,
cluster_name,
signal_list) as input_session:
terminated_cable = six.moves.input('Are you using a terminated cable (Y or N)? ')
if terminated_cable.lower() == "y":
input_session.intf.can_term = constants.CanTerm.ON
output_session.intf.can_term = constants.CanTerm.OFF
elif terminated_cable.lower() == "n":
input_session.intf.can_term = constants.CanTerm.ON
output_session.intf.can_term = constants.CanTerm.ON
else:
print("Unrecognised input ({}), assuming 'n'".format(terminated_cable))
input_session.intf.can_term = constants.CanTerm.ON
output_session.intf.can_term = constants.CanTerm.ON

# Start the input session manually to make sure that the first
# signal values sent before the initial read will be received.
input_session.start()

# Generate a pair of random values and send out the signals.
output_values = [randint(0, 255), randint(0, 255)]
output_session.signals.write(output_values)
print('Sent signal values: {}'.format(output_values))

# Wait 1 s and then read the received values.
# They should be the same as the ones sent.
time.sleep(1)

input_signals = input_session.signals.read()
input_values = [int(value) for timestamp, value in input_signals]
print('Received signal values: {}'.format(input_values))


if __name__ == '__main__':
main()
110 changes: 110 additions & 0 deletions nixnet_examples/lin_dynamic_database_creation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
from __future__ import absolute_import
from __future__ import division
from __future__ import print_function

from random import randint
import six
import time

import nixnet
from nixnet import constants
from nixnet import db


def main():
Copy link
Contributor

@epage epage Jan 22, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Each example

  • Should have a unit test
  • Should be included in the documentation

database_name = ':memory:'
cluster_name = 'LIN_Cluster'
ecu_1_name = 'LIN_ECU_1'
ecu_2_name = 'LIN_ECU_2'
schedule_name = 'LIN_Schedule_1'
schedule_entry_name = 'LIN_Schedule_Entry'
frame_name = 'LIN_Frame'
signal_1_name = 'LIN_Signal_1'
signal_2_name = 'LIN_Signal_2'
signal_list = [signal_1_name, signal_2_name]
output_interface = 'LIN1'
input_interface = 'LIN2'

# Open the default in-memory database.
with db.Database(database_name) as database:

# Add a LIN cluster, a frame, and two signals to the database.
cluster = database.clusters.add(cluster_name)
cluster.protocol = constants.Protocol.LIN
cluster.baud_rate = 19200
frame = cluster.frames.add(frame_name)
frame.id = 1
frame.payload_len = 2
signal_1 = frame.mux_static_signals.add(signal_1_name)
signal_1.byte_ordr = constants.SigByteOrdr.BIG_ENDIAN
signal_1.data_type = constants.SigDataType.UNSIGNED
signal_1.start_bit = 0
signal_1.num_bits = 8
signal_2 = frame.mux_static_signals.add(signal_2_name)
signal_2.byte_ordr = constants.SigByteOrdr.BIG_ENDIAN
signal_2.data_type = constants.SigDataType.UNSIGNED
signal_2.start_bit = 8
signal_2.num_bits = 8

# Add a LIN ECU and LIN Schedule to the cluster.
ecu_1 = cluster.ecus.add(ecu_1_name)
ecu_1.lin_protocol_ver = constants.LinProtocolVer.VER_2_2
ecu_1.lin_master = True
ecu_2 = cluster.ecus.add(ecu_2_name)
ecu_2.lin_protocol_ver = constants.LinProtocolVer.VER_2_2
ecu_2.lin_master = False
cluster.lin_tick = 0.01
schedule = cluster.lin_schedules.add(schedule_name)
schedule.priority = 0
schedule.run_mode = constants.LinSchedRunMode.CONTINUOUS
schedule_entry = schedule.entries.add(schedule_entry_name)
schedule_entry.delay = 1000.0
schedule_entry.type = constants.LinSchedEntryType.UNCONDITIONAL
schedule_entry.frames = [frame]

# Use the database we just created, write and then read a pair of signals.
with nixnet.SignalOutSinglePointSession(
output_interface,
database_name,
cluster_name,
signal_list) as output_session:
with nixnet.SignalInSinglePointSession(
input_interface,
database_name,
cluster_name,
signal_list) as input_session:
terminated_cable = six.moves.input('Are you using a terminated cable (Y or N)? ')
if terminated_cable.lower() == "y":
input_session.intf.lin_term = constants.LinTerm.ON
output_session.intf.lin_term = constants.LinTerm.OFF
elif terminated_cable.lower() == "n":
input_session.intf.lin_term = constants.LinTerm.ON
output_session.intf.lin_term = constants.LinTerm.ON
else:
print("Unrecognised input ({}), assuming 'n'".format(terminated_cable))
input_session.intf.lin_term = constants.LinTerm.ON
output_session.intf.lin_term = constants.LinTerm.ON

# Start the input session manually to make sure that the first
# signal values sent before the initial read will be received.
input_session.start()

# Set the schedule. This will also automatically enable master mode.
output_session.change_lin_schedule(0)

# Generate a pair of random values and send out the signals.
output_values = [randint(0, 255), randint(0, 255)]
output_session.signals.write(output_values)
print('Sent signal values: {}'.format(output_values))

# Wait 1 s and then read the received values.
# They should be the same as the ones sent.
time.sleep(1)

input_signals = input_session.signals.read()
input_values = [int(value) for timestamp, value in input_signals]
print('Received signal values: {}'.format(input_values))


if __name__ == '__main__':
main()
3 changes: 1 addition & 2 deletions nixnet_examples/lin_frame_stream_io.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,7 @@ def main():
# frame value sent before the initial read will be received.
input_session.start()

# Set the schedule. This will also automically enable
# master mode
# Set the schedule. This will also automatically enable master mode.
output_session.change_lin_schedule(0)

user_value = six.moves.input('Enter payload [int, int]: ')
Expand Down
Loading