Compare commits
30 Commits
c758aca6c6
..
v0.0.4
| Author | SHA1 | Date | |
|---|---|---|---|
| fe4bc0e46a | |||
| c9ae482174 | |||
| 5e6f81b50b | |||
| ce74c7fcd9 | |||
| 0f25c0671b | |||
| d0e70dad2a | |||
| f39d23fc64 | |||
| 7daf4c8e08 | |||
| 8a3fc81d12 | |||
| db7e5eb40e | |||
| 8ccb97afae | |||
| 13d91d566b | |||
| 118f1567a2 | |||
| cbba800536 | |||
| 17340746ce | |||
| ad8334c915 | |||
| 9a5a231841 | |||
| 74b393934c | |||
| 4a701e34c5 | |||
| c42afb34b3 | |||
| 70abf7b5ce | |||
| f975cba4f8 | |||
| 663d75174e | |||
| 324aa5652c | |||
| e27351aa28 | |||
| 6e386fcb4b | |||
| ca670c9bb7 | |||
| 725c9ccbc1 | |||
| 9d5cd74ef7 | |||
| 6ef0571e4e |
@@ -0,0 +1,9 @@
|
||||
# Copyright
|
||||
|
||||
Copyright © 2026 Erick Ahmed
|
||||
|
||||
The source code in this repository is licensed under the **GNU Affero General Public License v3.0 or later (AGPL-3.0-or-later)**.
|
||||
|
||||
A copy of the license is provided in the `LICENSE` file. If any discrepancy exists between this notice and the `LICENSE` file, the `LICENSE` file shall prevail.
|
||||
|
||||
Any third-party components included in this repository at any point during developement remain the property of their respective copyright holders and are subject to their own license terms.
|
||||
@@ -1,23 +1,21 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||
Version 3, 19 November 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
The GNU Affero General Public License is a free, copyleft license for
|
||||
software and other kinds of works, specifically designed to ensure
|
||||
cooperation with the community in the case of network server software.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
our General Public Licenses are intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
software for all its users.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
@@ -26,44 +24,34 @@ them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
Developers that use our General Public Licenses protect your rights
|
||||
with two steps: (1) assert copyright on the software, and (2) offer
|
||||
you this License which gives you legal permission to copy, distribute
|
||||
and/or modify the software.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
A secondary benefit of defending all users' freedom is that
|
||||
improvements made in alternate versions of the program, if they
|
||||
receive widespread use, become available for other developers to
|
||||
incorporate. Many developers of free software are heartened and
|
||||
encouraged by the resulting cooperation. However, in the case of
|
||||
software used on network servers, this result may fail to come about.
|
||||
The GNU General Public License permits making a modified version and
|
||||
letting the public access it on a server without ever releasing its
|
||||
source code to the public.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
The GNU Affero General Public License is designed specifically to
|
||||
ensure that, in such cases, the modified source code becomes available
|
||||
to the community. It requires the operator of a network server to
|
||||
provide the source code of the modified version running there to the
|
||||
users of that server. Therefore, public use of a modified version, on
|
||||
a publicly accessible server, gives the public access to the source
|
||||
code of the modified version.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
An older license, called the Affero General Public License and
|
||||
published by Affero, was designed to accomplish similar goals. This is
|
||||
a different license, not a version of the Affero GPL, but Affero has
|
||||
released a new version of the Affero GPL which permits relicensing under
|
||||
this license.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
@@ -72,7 +60,7 @@ modification follow.
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
"This License" refers to version 3 of the GNU Affero General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
@@ -549,35 +537,45 @@ to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
13. Remote Network Interaction; Use with the GNU General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, if you modify the
|
||||
Program, your modified version must prominently offer all users
|
||||
interacting with it remotely through a computer network (if your version
|
||||
supports such interaction) an opportunity to receive the Corresponding
|
||||
Source of your version by providing access to the Corresponding Source
|
||||
from a network server at no charge, through some standard or customary
|
||||
means of facilitating copying of software. This Corresponding Source
|
||||
shall include the Corresponding Source for any work covered by version 3
|
||||
of the GNU General Public License that is incorporated pursuant to the
|
||||
following paragraph.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
under version 3 of the GNU General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
but the work with which it is combined will remain governed by version
|
||||
3 of the GNU General Public License.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
the GNU Affero General Public License from time to time. Such new versions
|
||||
will be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Program specifies that a certain numbered version of the GNU Affero General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
GNU Affero General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
versions of the GNU Affero General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
@@ -635,40 +633,29 @@ the "copyright" line and a pointer to where the full notice is found.
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
it under the terms of the GNU Affero General Public License as published
|
||||
by the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
GNU Affero General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
You should have received a copy of the GNU Affero General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
If your software can interact with users remotely through a computer
|
||||
network, you should also make sure that it provides a way for users to
|
||||
get its source. For example, if your program is a web application, its
|
||||
interface could display a "Source" link that leads users to an archive
|
||||
of the code. There are many ways you could offer source, and different
|
||||
solutions will be better for different programs; see section 13 for the
|
||||
specific requirements.
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||
For more information on this, and how to apply and follow the GNU AGPL, see
|
||||
<http://www.gnu.org/licenses/>.
|
||||
+86
@@ -0,0 +1,86 @@
|
||||
# File: decoder.py
|
||||
# Copyright (C) 2026 Erick Ahmed
|
||||
# SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
|
||||
import argparse
|
||||
import polars as pl
|
||||
|
||||
def get_j1939_mask() -> pl.Expr:
|
||||
"""
|
||||
Returns a Polars expression representing the strict J1939 filtering rules.
|
||||
"""
|
||||
id_int = pl.col("ID").str.to_integer(base=16).cast(pl.UInt32)
|
||||
return id_int > 0x7FF
|
||||
|
||||
def decode_j1939_metadata(lf: pl.LazyFrame) -> pl.LazyFrame:
|
||||
"""
|
||||
Decodes J1939 fields and bundles them into a Struct column.
|
||||
"""
|
||||
id_int = pl.col("ID").str.to_integer(base=16).cast(pl.UInt32)
|
||||
|
||||
priority = ((id_int // 67108864) % 8).cast(pl.UInt8)
|
||||
pf = ((id_int // 65536) % 256).cast(pl.UInt8)
|
||||
ps = ((id_int // 256) % 256).cast(pl.UInt8)
|
||||
sa = (id_int % 256).cast(pl.UInt8)
|
||||
|
||||
da = pl.when(pf < 240).then(ps).otherwise(pl.lit(255, dtype=pl.UInt8)).cast(pl.UInt8)
|
||||
|
||||
pgn = pl.when(pf < 240).then(
|
||||
((id_int // 256) & 0x3FF00)
|
||||
).otherwise(
|
||||
((id_int // 256) & 0x3FFFF)
|
||||
).cast(pl.UInt32)
|
||||
|
||||
return lf.with_columns(
|
||||
pl.struct([
|
||||
priority.alias("Priority"),
|
||||
pf.alias("PF"),
|
||||
ps.alias("PS"),
|
||||
sa.alias("SA"),
|
||||
da.alias("DA"),
|
||||
pgn.alias("PGN")
|
||||
]).alias("j1939_metadata")
|
||||
)
|
||||
|
||||
def decode_j1939_frames(df: pl.DataFrame) -> pl.DataFrame:
|
||||
id_int = pl.col("ID").str.to_integer(base=16).cast(pl.UInt32)
|
||||
|
||||
is_j1939 = id_int > 0x7FF
|
||||
|
||||
priority = ((id_int // 67108864) % 8).cast(pl.UInt8)
|
||||
pf = ((id_int // 65536) % 256).cast(pl.UInt8)
|
||||
ps = ((id_int // 256) % 256).cast(pl.UInt8)
|
||||
sa = (id_int % 256).cast(pl.UInt8)
|
||||
|
||||
da = pl.when(pf < 240).then(ps).otherwise(pl.lit(255, dtype=pl.UInt8)).cast(pl.UInt8)
|
||||
|
||||
pgn = pl.when(pf < 240).then(
|
||||
((id_int // 256) & 0x3FF00)
|
||||
).otherwise(
|
||||
((id_int // 256) & 0x3FFFF)
|
||||
).cast(pl.UInt32)
|
||||
|
||||
j1939_meta = pl.when(is_j1939).then(
|
||||
pl.struct([
|
||||
priority.alias("Priority"),
|
||||
pf.alias("PF"),
|
||||
ps.alias("PS"),
|
||||
sa.alias("SA"),
|
||||
da.alias("DA"),
|
||||
pgn.alias("PGN")
|
||||
])
|
||||
).otherwise(None)
|
||||
|
||||
return df.with_columns(j1939_meta.alias("j1939_metadata"))
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
parser = argparse.ArgumentParser(description="J1939 decoder")
|
||||
parser.add_argument("input_parquet", help="Path to the raw .parquet file")
|
||||
parser.add_argument("output_parquet", help="Path to save the decoded .parquet file")
|
||||
args = parser.parse_args()
|
||||
|
||||
df = pl.scan_parquet(args.input_parquet).collect()
|
||||
decoded_df = decode_j1939_frames(df)
|
||||
|
||||
decoded_df.write_parquet(args.output_parquet)
|
||||
@@ -0,0 +1,3 @@
|
||||
# File: main.py
|
||||
# Copyright (C) 2026 Erick Ahmed
|
||||
# SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
@@ -1,3 +1,7 @@
|
||||
# File: parser.py
|
||||
# Copyright (C) 2026 Erick Ahmed
|
||||
# SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
|
||||
import re
|
||||
import csv
|
||||
import polars as pl
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
[project]
|
||||
name = "CANveyor"
|
||||
version = "0.1.0"
|
||||
version = "0.0.1"
|
||||
description = "J1939 CAN bus parser that works in pair with CANdigger"
|
||||
readme = "README.md"
|
||||
requires-python = ">=3.14"
|
||||
|
||||
@@ -0,0 +1,144 @@
|
||||
# File: correlation.py
|
||||
# Copyright (C) 2026 Erick Ahmed
|
||||
# SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
|
||||
import argparse
|
||||
from pathlib import Path
|
||||
|
||||
import numpy as np
|
||||
import pandas as pd
|
||||
import plotly.graph_objects as go
|
||||
|
||||
from utils.extractor import load_data
|
||||
|
||||
|
||||
def _to_int(x):
|
||||
"""Convert a hex string or integer to int, returning NaN on failure."""
|
||||
if isinstance(x, (int, np.integer)):
|
||||
return int(x)
|
||||
if isinstance(x, str):
|
||||
try:
|
||||
return int(x, 16)
|
||||
except ValueError:
|
||||
return np.nan
|
||||
return np.nan
|
||||
|
||||
|
||||
def calculate_correlation(df: pd.DataFrame, method: str, target_id: str | None = None) -> pd.DataFrame:
|
||||
"""Calculates inter-byte correlation grouped by identifier."""
|
||||
byte_cols = [f"b{i}" for i in range(8)]
|
||||
available_cols = [col for col in byte_cols if col in df.columns]
|
||||
|
||||
if not available_cols:
|
||||
raise ValueError("No byte columns (b0-b7) found in the DataFrame")
|
||||
|
||||
df_bytes = df[["Identifier"] + available_cols].copy()
|
||||
for col in available_cols:
|
||||
df_bytes[col] = df_bytes[col].apply(_to_int)
|
||||
|
||||
if target_id:
|
||||
group = df_bytes[df_bytes["Identifier"] == target_id]
|
||||
if group.empty:
|
||||
raise ValueError(f"Identifier '{target_id}' not found in data")
|
||||
return group[available_cols].corr(method=method).fillna(0.0)
|
||||
|
||||
def max_abs_corr(group: pd.DataFrame) -> pd.Series:
|
||||
corr_arr = np.abs(group.corr(method=method).to_numpy().copy())
|
||||
np.fill_diagonal(corr_arr, 0.0)
|
||||
return pd.Series(corr_arr.max(axis=0), index=group.columns).fillna(0.0)
|
||||
|
||||
return df_bytes.groupby("Identifier")[available_cols].apply(max_abs_corr)
|
||||
|
||||
|
||||
def plot_correlation_heatmap(corr_df: pd.DataFrame, target_id: str | None, title: str) -> go.Figure:
|
||||
"""Generates an interactive heatmap of inter-byte correlation."""
|
||||
is_8x8 = target_id is not None
|
||||
|
||||
if is_8x8:
|
||||
x = corr_df.columns.tolist()
|
||||
y = corr_df.index.tolist()
|
||||
z = corr_df.values
|
||||
z_min, z_max = -1.0, 1.0
|
||||
colorscale = [
|
||||
[0.0, "#2c7bb6"], [0.25, "#abd9e9"], [0.5, "#ffffff"],
|
||||
[0.75, "#fdae61"], [1.0, "#d7191c"]
|
||||
]
|
||||
hover_template = "<b>%{y}</b> vs <b>%{x}</b><br>Correlation: %{z:.2f}<extra></extra>"
|
||||
else:
|
||||
x = corr_df.columns.tolist()
|
||||
y = corr_df.index.tolist()
|
||||
z = corr_df.values
|
||||
z_min, z_max = 0.0, 1.0
|
||||
colorscale = [
|
||||
[0.0, "#ffffff"], [0.2, "#fff5f0"], [0.4, "#fecc5c"],
|
||||
[0.6, "#fd8d3c"], [0.8, "#e31a1c"], [1.0, "#800026"]
|
||||
]
|
||||
hover_template = "<b>%{y}</b><br>Byte %{x} max correlation: %{z:.2f}<extra></extra>"
|
||||
|
||||
fig = go.Figure(
|
||||
data=go.Heatmap(
|
||||
z=z, x=x, y=y,
|
||||
zmin=z_min, zmax=z_max,
|
||||
colorscale=colorscale,
|
||||
xgap=3, ygap=3,
|
||||
text=np.round(z, 2),
|
||||
texttemplate="%{text}",
|
||||
textfont={"size": 11, "color": "#2a2a2a", "family": "Segoe UI, Arial, sans-serif"},
|
||||
hoverongaps=False,
|
||||
hovertemplate=hover_template,
|
||||
colorbar=dict(
|
||||
title=dict(text="Correlation", side="top", font=dict(size=13, color="#1a1a1a")),
|
||||
orientation="h", thickness=15, len=0.35,
|
||||
x=1.0, xanchor="right", y=1.02, yanchor="bottom",
|
||||
tickfont=dict(size=11, color="#2a2a2a"),
|
||||
tickformat=".1f", outlinewidth=0.5, outlinecolor="#cccccc",
|
||||
),
|
||||
)
|
||||
)
|
||||
|
||||
fig.update_layout(
|
||||
title=dict(text=title, font=dict(size=20, color="#1a1a1a"), x=0.5, xanchor="center", pad=dict(b=20)),
|
||||
height=max(600, len(y) * 28 + 150) if not is_8x8 else 600,
|
||||
autosize=True,
|
||||
template="plotly_white",
|
||||
xaxis=dict(
|
||||
title=dict(text="Byte Position", font=dict(size=13, color="#1a1a1a")),
|
||||
side="top" if not is_8x8 else "bottom",
|
||||
dtick=1, showgrid=False, linecolor="#bdbdbd",
|
||||
tickfont=dict(size=12, color="#2a2a2a"), ticks="outside", ticklen=4, tickcolor="#cccccc",
|
||||
),
|
||||
yaxis=dict(
|
||||
title=dict(text="PGN or CAN ID" if not is_8x8 else "Byte Position", font=dict(size=13, color="#1a1a1a")),
|
||||
autorange="reversed", showgrid=False, linecolor="#bdbdbd",
|
||||
tickfont=dict(size=12, color="#2a2a2a"), ticks="outside", ticklen=4, tickcolor="#cccccc", automargin=True,
|
||||
),
|
||||
font=dict(family="Segoe UI, Arial, sans-serif", size=12, color="#2a2a2a"),
|
||||
hoverlabel=dict(bgcolor="white", font_size=13, font_family="Segoe UI", bordercolor="#cccccc"),
|
||||
margin=dict(l=200, r=40, t=120, b=60),
|
||||
)
|
||||
return fig
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
parser = argparse.ArgumentParser(description="Analyze CAN bus inter-byte correlation")
|
||||
parser.add_argument("method", choices=["pearson", "spearman"], help="Correlation method to use")
|
||||
parser.add_argument("input", type=Path, help="Path to the input CAN log file")
|
||||
parser.add_argument("output", type=Path, nargs="?", default=Path("correlation_report.html"), help="Path to the output HTML report")
|
||||
parser.add_argument("title", nargs="?", default="CAN Bus Inter-Byte Correlation", help="Title for the HTML report")
|
||||
parser.add_argument("--identifier", type=str, default=None, help="Specific PGN/CAN ID to analyze (e.g., 'PGN: 65331'). If omitted, shows max correlation per byte for all IDs.")
|
||||
args = parser.parse_args()
|
||||
|
||||
df = load_data(args.input)
|
||||
corr_df = calculate_correlation(df, method=args.method, target_id=args.identifier)
|
||||
|
||||
display_title = f"{args.title} ({args.identifier})" if args.identifier else args.title
|
||||
fig = plot_correlation_heatmap(corr_df, target_id=args.identifier, title=display_title)
|
||||
|
||||
config = {
|
||||
"responsive": True,
|
||||
"displaylogo": False,
|
||||
"scrollZoom": True,
|
||||
"modeBarButtonsToAdd": ["toggleSpikelines"],
|
||||
"toImageButtonOptions": {"format": "png", "scale": 2},
|
||||
}
|
||||
fig.write_html(str(args.output), include_plotlyjs="cdn", config=config)
|
||||
+180
@@ -0,0 +1,180 @@
|
||||
# File: entropy.py
|
||||
# Copyright (C) 2026 Erick Ahmed
|
||||
# SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
|
||||
import argparse
|
||||
from pathlib import Path
|
||||
|
||||
import numpy as np
|
||||
import pandas as pd
|
||||
import plotly.graph_objects as go
|
||||
|
||||
from utils.extractor import load_data
|
||||
|
||||
|
||||
def _to_int(x):
|
||||
"""Convert a hex string or integer to int, returning NaN on failure."""
|
||||
if isinstance(x, (int, np.integer)):
|
||||
return int(x)
|
||||
if isinstance(x, str):
|
||||
try:
|
||||
return int(x, 16)
|
||||
except ValueError:
|
||||
return np.nan
|
||||
return np.nan
|
||||
|
||||
|
||||
def calculate_byte_entropy(df: pd.DataFrame) -> pd.DataFrame:
|
||||
"""Calculates Shannon entropy per byte position for each identifier."""
|
||||
byte_cols = [f"b{i}" for i in range(8)]
|
||||
available_cols = [col for col in byte_cols if col in df.columns]
|
||||
if not available_cols:
|
||||
raise ValueError("No byte columns (b0-b7) found in the DataFrame")
|
||||
|
||||
df_bytes = df[available_cols].copy()
|
||||
for col in available_cols:
|
||||
df_bytes[col] = df_bytes[col].apply(_to_int)
|
||||
|
||||
def entropy(s: pd.Series) -> float:
|
||||
s = s.dropna()
|
||||
if s.empty:
|
||||
return 0.0
|
||||
p = s.value_counts(normalize=True)
|
||||
return -np.sum(p * np.log2(p))
|
||||
|
||||
return df.groupby("Identifier")[available_cols].agg(entropy)
|
||||
|
||||
|
||||
def plot_entropy_heatmap(entropy_df: pd.DataFrame, title: str) -> go.Figure:
|
||||
"""Generates an interactive heatmap of byte-level Shannon entropy."""
|
||||
x = entropy_df.columns.tolist()
|
||||
y = entropy_df.index.tolist()
|
||||
z = entropy_df.values
|
||||
|
||||
fig = go.Figure(
|
||||
data=go.Heatmap(
|
||||
z=z,
|
||||
x=x,
|
||||
y=y,
|
||||
colorscale=[
|
||||
[0.0, "#ffffff"],
|
||||
[0.15, "#fff7ec"],
|
||||
[0.35, "#fee8c8"],
|
||||
[0.55, "#fdd49e"],
|
||||
[0.75, "#fdbb84"],
|
||||
[1.0, "#ef6548"],
|
||||
],
|
||||
xgap=3,
|
||||
ygap=3,
|
||||
text=np.round(z, 2),
|
||||
texttemplate="%{text}",
|
||||
textfont={
|
||||
"size": 11,
|
||||
"color": "#2a2a2a",
|
||||
"family": "Segoe UI, Arial, sans-serif",
|
||||
},
|
||||
hoverongaps=False,
|
||||
hovertemplate=(
|
||||
"<b>%{y}</b><br>"
|
||||
"Byte %{x}: %{z:.2f} bits<extra></extra>"
|
||||
),
|
||||
colorbar=dict(
|
||||
title=dict(
|
||||
text="Entropy (bits)",
|
||||
side="top",
|
||||
font=dict(size=13, color="#1a1a1a"),
|
||||
),
|
||||
orientation="h",
|
||||
thickness=15,
|
||||
len=0.35,
|
||||
x=1.0,
|
||||
xanchor="right",
|
||||
y=1.02,
|
||||
yanchor="bottom",
|
||||
tickfont=dict(size=11, color="#2a2a2a"),
|
||||
tickformat=".1f",
|
||||
outlinewidth=0.5,
|
||||
outlinecolor="#cccccc",
|
||||
),
|
||||
)
|
||||
)
|
||||
|
||||
fig.update_layout(
|
||||
title=dict(
|
||||
text=title,
|
||||
font=dict(size=20, color="#1a1a1a"),
|
||||
x=0.5,
|
||||
xanchor="center",
|
||||
pad=dict(b=20),
|
||||
),
|
||||
height=max(600, len(y) * 28 + 150),
|
||||
autosize=True,
|
||||
template="plotly_white",
|
||||
xaxis=dict(
|
||||
title=dict(text="Byte Position", font=dict(size=13, color="#1a1a1a")),
|
||||
side="top",
|
||||
dtick=1,
|
||||
showgrid=False,
|
||||
linecolor="#bdbdbd",
|
||||
tickfont=dict(size=12, color="#2a2a2a"),
|
||||
ticks="outside",
|
||||
ticklen=4,
|
||||
tickcolor="#cccccc",
|
||||
),
|
||||
yaxis=dict(
|
||||
title=dict(text="PGN or CAN ID", font=dict(size=13, color="#1a1a1a")),
|
||||
autorange="reversed",
|
||||
showgrid=False,
|
||||
linecolor="#bdbdbd",
|
||||
tickfont=dict(size=12, color="#2a2a2a"),
|
||||
ticks="outside",
|
||||
ticklen=4,
|
||||
tickcolor="#cccccc",
|
||||
automargin=True,
|
||||
),
|
||||
font=dict(family="Segoe UI, Arial, sans-serif", size=12, color="#2a2a2a"),
|
||||
hoverlabel=dict(
|
||||
bgcolor="white",
|
||||
font_size=13,
|
||||
font_family="Segoe UI",
|
||||
bordercolor="#cccccc",
|
||||
),
|
||||
margin=dict(l=200, r=40, t=120, b=60),
|
||||
)
|
||||
return fig
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
parser = argparse.ArgumentParser(
|
||||
description="Analyze CAN bus byte-level entropy"
|
||||
)
|
||||
parser.add_argument(
|
||||
"input", type=Path, help="Path to the input CAN log file"
|
||||
)
|
||||
parser.add_argument(
|
||||
"output",
|
||||
type=Path,
|
||||
nargs="?",
|
||||
default=Path("entropy_report.html"),
|
||||
help="Path to the output HTML report",
|
||||
)
|
||||
parser.add_argument(
|
||||
"title",
|
||||
nargs="?",
|
||||
default="CAN Bus Byte-Level Entropy",
|
||||
help="Title for the HTML report",
|
||||
)
|
||||
args = parser.parse_args()
|
||||
|
||||
df = load_data(args.input)
|
||||
entropy_df = calculate_byte_entropy(df)
|
||||
fig = plot_entropy_heatmap(entropy_df, title=args.title)
|
||||
|
||||
config = {
|
||||
"responsive": True,
|
||||
"displaylogo": False,
|
||||
"scrollZoom": True,
|
||||
"modeBarButtonsToAdd": ["toggleSpikelines"],
|
||||
"toImageButtonOptions": {"format": "png", "scale": 2},
|
||||
}
|
||||
fig.write_html(str(args.output), include_plotlyjs="cdn", config=config)
|
||||
@@ -0,0 +1,116 @@
|
||||
# File: frequency.py
|
||||
# Copyright (C) 2026 Erick Ahmed
|
||||
# SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
|
||||
import argparse
|
||||
from pathlib import Path
|
||||
import pandas as pd
|
||||
import plotly.express as px
|
||||
import plotly.graph_objects as go
|
||||
from utils.extractor import load_data
|
||||
|
||||
def calc_freq(df: pd.DataFrame) -> pd.DataFrame:
|
||||
"""Calculates frequency counts and percentages for identifiers."""
|
||||
freq_df = df['Identifier'].value_counts().reset_index()
|
||||
freq_df.columns = ['Identifier', 'Count']
|
||||
total = freq_df['Count'].sum()
|
||||
freq_df['Percentage'] = (freq_df['Count'] / total * 100).round(2)
|
||||
return freq_df.sort_values('Count', ascending=True)
|
||||
|
||||
def plot_freq(stats_df: pd.DataFrame, title: str) -> go.Figure:
|
||||
"""Generates interactive horizontal bar chart with log x-axis."""
|
||||
fig = px.bar(
|
||||
stats_df, y='Identifier', x='Count', orientation='h', title=title, log_x=True,
|
||||
labels={'Identifier': 'PGN / CAN ID', 'Count': 'Message Count'},
|
||||
color='Count', color_continuous_scale='Turbo',
|
||||
range_color=(stats_df['Count'].min(), stats_df['Count'].max()),
|
||||
hover_data={'Percentage': ':.2f', 'Count': ':,', 'Identifier': True}
|
||||
)
|
||||
fig.update_layout(
|
||||
height=max(600, len(stats_df) * 18),
|
||||
autosize=True,
|
||||
template='plotly_white',
|
||||
xaxis=dict(
|
||||
title=dict(text="Message count [log scale]", font=dict(size=13, color="#1a1a1a")),
|
||||
side="top",
|
||||
dtick=1,
|
||||
showgrid=False,
|
||||
linecolor="#bdbdbd",
|
||||
tickfont=dict(size=12, color="#2a2a2a"),
|
||||
ticks="outside",
|
||||
ticklen=4,
|
||||
tickcolor="#cccccc",
|
||||
),
|
||||
yaxis=dict(
|
||||
title=dict(text="PGN or CAN ID", font=dict(size=13, color="#1a1a1a")),
|
||||
#autorange="",
|
||||
showgrid=False,
|
||||
linecolor="#bdbdbd",
|
||||
tickfont=dict(size=12, color="#2a2a2a"),
|
||||
ticks="outside",
|
||||
ticklen=4,
|
||||
tickcolor="#cccccc",
|
||||
automargin=True,
|
||||
),
|
||||
font=dict(family="Segoe UI, Arial, sans-serif", size=12, color='#2a2a2a'),
|
||||
hoverlabel=dict(bgcolor="white", font_size=13, font_family="Segoe UI",
|
||||
bordercolor='#cccccc'),
|
||||
margin=dict(l=200, r=40, t=120, b=60),
|
||||
bargap=0.35,
|
||||
coloraxis_colorbar=dict(
|
||||
title=dict(text='Message Count', side='top'),
|
||||
orientation='h',
|
||||
thickness=15,
|
||||
len=0.35,
|
||||
x=1.0,
|
||||
xanchor='right',
|
||||
y=1.02,
|
||||
yanchor='bottom',
|
||||
tickformat=',',
|
||||
outlinecolor='#cccccc',
|
||||
outlinewidth=0.5
|
||||
),
|
||||
title=dict(font=dict(size=20, color='#1a1a1a'), x=0.5, xanchor='center',
|
||||
pad=dict(b=20))
|
||||
)
|
||||
fig.update_xaxes(
|
||||
showgrid=True, gridwidth=0.5, gridcolor='#e8e8e8',
|
||||
zeroline=False, linecolor='#bdbdbd', mirror=False,
|
||||
tickformat=',',
|
||||
minor=dict(showgrid=True, gridcolor='#f4f4f4', gridwidth=0.5)
|
||||
)
|
||||
fig.update_yaxes(
|
||||
showgrid=False, zeroline=False, linecolor='#bdbdbd',
|
||||
ticks='outside', ticklen=4, tickcolor='#cccccc',
|
||||
automargin=True
|
||||
)
|
||||
fig.update_traces(
|
||||
hovertemplate="<b>%{y}</b><br>Count: %{x:,}<br>Share: %{customdata[0]}%<extra></extra>",
|
||||
marker_line_width=0,
|
||||
texttemplate='%{x:,}',
|
||||
textposition='outside',
|
||||
textfont=dict(size=10, color='#666666'),
|
||||
cliponaxis=False,
|
||||
selected=dict(marker=dict(opacity=0.6)),
|
||||
unselected=dict(marker=dict(opacity=0.2))
|
||||
)
|
||||
return fig
|
||||
|
||||
if __name__ == "__main__":
|
||||
parser = argparse.ArgumentParser(description="Analyze CAN bus message frequency")
|
||||
parser.add_argument("input", type=Path, help="Path to the input CAN log file")
|
||||
parser.add_argument("output", type=Path, nargs="?", default=Path("freq_report.html"), help="Path to the output HTML report")
|
||||
parser.add_argument("title", nargs="?", default="CAN Bus Message Frequency", help="Title for the HTML report")
|
||||
args = parser.parse_args()
|
||||
|
||||
df = load_data(args.input)
|
||||
stats = calc_freq(df)
|
||||
fig = plot_freq(stats, title=args.title)
|
||||
config = {
|
||||
'responsive': True,
|
||||
'displaylogo': False,
|
||||
'scrollZoom': True,
|
||||
'modeBarButtonsToAdd': ['toggleSpikelines'],
|
||||
'toImageButtonOptions': {'format': 'png', 'scale': 2}
|
||||
}
|
||||
fig.write_html(str(args.output), include_plotlyjs='cdn', config=config)
|
||||
@@ -0,0 +1,36 @@
|
||||
import json
|
||||
from pathlib import Path
|
||||
|
||||
import numpy as np
|
||||
import pandas as pd
|
||||
|
||||
def to_int(x):
|
||||
"""Convert a hex string or integer to int, returning NaN on failure."""
|
||||
if isinstance(x, (int, np.integer)):
|
||||
return int(x)
|
||||
if isinstance(x, str):
|
||||
try:
|
||||
return int(x, 16)
|
||||
except ValueError:
|
||||
return np.nan
|
||||
return np.nan
|
||||
|
||||
def extract_id(row: pd.Series) -> str:
|
||||
"""Extracts PGN from metadata or falls back to CAN ID."""
|
||||
meta = row.get('j1939_metadata')
|
||||
if pd.isna(meta):
|
||||
return f"ID: {row['ID']}"
|
||||
if isinstance(meta, str):
|
||||
try:
|
||||
meta = json.loads(meta)
|
||||
except json.JSONDecodeError:
|
||||
return f"ID: {row['ID']}"
|
||||
if isinstance(meta, dict) and 'PGN' in meta:
|
||||
return f"PGN: {meta['PGN']}"
|
||||
return f"ID: {row['ID']}"
|
||||
|
||||
def load_data(file_path: Path) -> pd.DataFrame:
|
||||
"""Loads Parquet file and adds an Identifier column."""
|
||||
df = pd.read_parquet(file_path)
|
||||
df['Identifier'] = df.apply(extract_id, axis=1)
|
||||
return df
|
||||
Reference in New Issue
Block a user