Removed Nix and the sample-main, added a CI/CD pipeline and updated the README.md
Some checks failed
Check, format and test / build (push) Failing after 49s
Some checks failed
Check, format and test / build (push) Failing after 49s
This commit is contained in:
parent
987af19ec8
commit
b2b5f0c66c
31
.gitea/workflows/check-format-and-test.yaml
Normal file
31
.gitea/workflows/check-format-and-test.yaml
Normal file
@ -0,0 +1,31 @@
|
||||
name: Check, format and test
|
||||
|
||||
on:
|
||||
push:
|
||||
|
||||
jobs:
|
||||
build:
|
||||
container: docker.io/rust:1.79.0-alpine3.20
|
||||
steps:
|
||||
- name: Install the dependencies
|
||||
run: |
|
||||
rustup component add clippy rustfmt &&
|
||||
apk update &&
|
||||
apk add musl-dev git npm
|
||||
|
||||
- name: Checkout the code
|
||||
uses: actions/checkout@v3
|
||||
with:
|
||||
submodules: recursive
|
||||
|
||||
- name: Check if the code compiles
|
||||
run: cargo check
|
||||
|
||||
- name: Check if the tests run correctly
|
||||
run: cargo test
|
||||
|
||||
- name: Check if the code is formatted correctly
|
||||
run: cargo fmt --check
|
||||
|
||||
- name: Check if Clippy has someting to say
|
||||
run: cargo clippy --all-targets
|
||||
8
Cargo.lock
generated
8
Cargo.lock
generated
@ -145,14 +145,6 @@ dependencies = [
|
||||
"serde",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "sample-main"
|
||||
version = "0.1.0"
|
||||
dependencies = [
|
||||
"chrono",
|
||||
"r701",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "serde"
|
||||
version = "1.0.203"
|
||||
|
||||
28
Cargo.toml
28
Cargo.toml
@ -1,6 +1,22 @@
|
||||
[workspace]
|
||||
resolver = "2"
|
||||
members = [
|
||||
"r701",
|
||||
"sample-main",
|
||||
]
|
||||
[package]
|
||||
name = "r701"
|
||||
version = "0.1.0"
|
||||
edition = "2021"
|
||||
license = "GNU AGPLv3.0"
|
||||
repository = "https://git.nicolabelluti.me/nicolabelluti/r701"
|
||||
|
||||
[dependencies]
|
||||
chrono = { version = "0.4.38", default-features = false, features = ["clock"] }
|
||||
serde = { version = "1.0.203", default-features = false, features = ["derive"], optional = true }
|
||||
|
||||
[features]
|
||||
serde = ["chrono/serde", "dep:serde"]
|
||||
|
||||
[lints.rust]
|
||||
unsafe_code = "forbid"
|
||||
|
||||
[lints.clippy]
|
||||
unwrap_used = "deny"
|
||||
enum_glob_use = { level = "deny", priority = 1 }
|
||||
pedantic = { level = "deny", priority = -1 }
|
||||
nursery = { level = "deny", priority = -1 }
|
||||
|
||||
58
README.md
58
README.md
@ -1,8 +1,60 @@
|
||||
# R701 🦀
|
||||
<div align="center">
|
||||
|
||||
# R701 🕰️
|
||||
|
||||
[](https://www.rust-lang.org)
|
||||
[](https://brainmade.org)
|
||||
[](https://choosealicense.com/licenses/agpl-3.0)
|
||||
[](https://buymeacoffee.com/nicolabelluti)
|
||||
<br>
|
||||
[](https://git.nicolabelluti.me/nicolabelluti/r701/actions/?workflow=check-format-and-test.yaml)
|
||||
|
||||
</div>
|
||||
|
||||
> A reverse-engineered library to communicate with the
|
||||
> [R701](https://ipsattendant.it/rilevatore-presenze-r701/) by [I.P.S.
|
||||
> Informatica](https://ipsinformatica.info/) via TCP, written in Rust
|
||||
> Informatica](https://ipsinformatica.info/), written in Rust
|
||||
|
||||
If you want to read about this reverse engineering attempt you can check out
|
||||
If you want to read about this reverse engineering attempt, check out
|
||||
<https://nicolabelluti.me/series/attendance-reader/>.
|
||||
|
||||
1. Add the library to you project:
|
||||
|
||||
```shell
|
||||
cargo add r701 --git https://git.nicolabelluti.me/nicolabelluti/r701.git
|
||||
```
|
||||
|
||||
2. Use the library in you project:
|
||||
|
||||
```rust
|
||||
use r701::R701;
|
||||
|
||||
fn main() {
|
||||
let mut r701 = R701::connect("127.0.0.1:5005").unwrap();
|
||||
|
||||
println!("No\tMchn\tEnNo\t\tName\t\tMode\tIOMd\tDateTime\t");
|
||||
r701.into_record_iter()
|
||||
.unwrap()
|
||||
.collect::<Vec<_>>()
|
||||
.iter()
|
||||
.rev()
|
||||
.enumerate()
|
||||
.for_each(|(id, record)| {
|
||||
let name = r701
|
||||
.get_name(record.employee_id)
|
||||
.unwrap()
|
||||
.unwrap_or(format!("user #{}", record.employee_id));
|
||||
|
||||
println!(
|
||||
"{:0>6}\t{}\t{:0>9}\t{: <10}\t{}\t{}\t{}",
|
||||
id + 1,
|
||||
1,
|
||||
record.employee_id,
|
||||
name,
|
||||
35,
|
||||
record.clock as u8,
|
||||
record.datetime.format("%Y/%m/%d %H:%M:%S"),
|
||||
);
|
||||
});
|
||||
}
|
||||
```
|
||||
|
||||
27
flake.lock
generated
27
flake.lock
generated
@ -1,27 +0,0 @@
|
||||
{
|
||||
"nodes": {
|
||||
"nixpkgs": {
|
||||
"locked": {
|
||||
"lastModified": 1718318537,
|
||||
"narHash": "sha256-4Zu0RYRcAY/VWuu6awwq4opuiD//ahpc2aFHg2CWqFY=",
|
||||
"owner": "nixos",
|
||||
"repo": "nixpkgs",
|
||||
"rev": "e9ee548d90ff586a6471b4ae80ae9cfcbceb3420",
|
||||
"type": "github"
|
||||
},
|
||||
"original": {
|
||||
"owner": "nixos",
|
||||
"ref": "nixos-unstable",
|
||||
"repo": "nixpkgs",
|
||||
"type": "github"
|
||||
}
|
||||
},
|
||||
"root": {
|
||||
"inputs": {
|
||||
"nixpkgs": "nixpkgs"
|
||||
}
|
||||
}
|
||||
},
|
||||
"root": "root",
|
||||
"version": 7
|
||||
}
|
||||
23
flake.nix
23
flake.nix
@ -1,23 +0,0 @@
|
||||
{
|
||||
description = "Rust setup";
|
||||
|
||||
inputs = {
|
||||
nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
|
||||
};
|
||||
|
||||
outputs = { self, nixpkgs, ... }:
|
||||
let
|
||||
system = "x86_64-linux";
|
||||
pkgs = nixpkgs.legacyPackages.${system};
|
||||
in {
|
||||
devShells.${system}.default = pkgs.mkShell {
|
||||
|
||||
buildInputs = with pkgs; [
|
||||
cargo
|
||||
clippy
|
||||
rustfmt
|
||||
];
|
||||
|
||||
};
|
||||
};
|
||||
}
|
||||
@ -1,13 +0,0 @@
|
||||
[package]
|
||||
name = "r701"
|
||||
version = "0.1.0"
|
||||
edition = "2021"
|
||||
|
||||
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
||||
|
||||
[dependencies]
|
||||
chrono = { version = "0.4.38", default-features = false, features = ["clock"] }
|
||||
serde = { version = "1.0.203", default-features = false, features = ["derive"], optional = true }
|
||||
|
||||
[features]
|
||||
serde = ["chrono/serde", "dep:serde"]
|
||||
@ -1,8 +0,0 @@
|
||||
[package]
|
||||
name = "sample-main"
|
||||
version = "0.1.0"
|
||||
edition = "2021"
|
||||
|
||||
[dependencies]
|
||||
r701 = { path = "../r701" }
|
||||
chrono = { version = "0.4.38", default-features = false }
|
||||
@ -1,39 +0,0 @@
|
||||
use chrono::{Local, TimeZone};
|
||||
use r701::R701;
|
||||
use std::collections::HashMap;
|
||||
|
||||
fn main() {
|
||||
let start = Local.with_ymd_and_hms(1970, 1, 1, 0, 0, 0).unwrap();
|
||||
let end = Local.with_ymd_and_hms(9999, 1, 1, 0, 0, 0).unwrap();
|
||||
let mut names = HashMap::new();
|
||||
|
||||
let mut r701 = R701::connect("127.0.0.1:5005").unwrap();
|
||||
|
||||
println!("No\tMchn\tEnNo\t\tName\t\tMode\tIOMd\tDateTime\t");
|
||||
r701.into_record_iter()
|
||||
.unwrap()
|
||||
.take_while(|record| record.datetime >= start)
|
||||
.skip_while(|record| record.datetime >= end)
|
||||
.collect::<Vec<_>>()
|
||||
.iter()
|
||||
.rev()
|
||||
.enumerate()
|
||||
.for_each(|(id, record)| {
|
||||
let name = names.entry(record.employee_id).or_insert_with(|| {
|
||||
r701.get_name(record.employee_id)
|
||||
.unwrap()
|
||||
.unwrap_or(format!("user #{}", record.employee_id))
|
||||
});
|
||||
|
||||
println!(
|
||||
"{:0>6}\t{}\t{:0>9}\t{: <10}\t{}\t{}\t{}",
|
||||
id + 1,
|
||||
1,
|
||||
record.employee_id,
|
||||
name,
|
||||
35,
|
||||
record.clock as u8,
|
||||
record.datetime.format("%Y/%m/%d %H:%M:%S"),
|
||||
);
|
||||
});
|
||||
}
|
||||
@ -12,8 +12,8 @@ pub enum Clock {
|
||||
SecondOut,
|
||||
}
|
||||
|
||||
unsafe impl Send for Clock {}
|
||||
unsafe impl Sync for Clock {}
|
||||
// unsafe impl Send for Clock {}
|
||||
// unsafe impl Sync for Clock {}
|
||||
|
||||
#[derive(Debug, Clone, Copy, Default, Eq, PartialEq, Ord, PartialOrd, Hash)]
|
||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||
@ -23,16 +23,16 @@ pub struct Record {
|
||||
pub datetime: DateTime<Local>,
|
||||
}
|
||||
|
||||
unsafe impl Send for Record {}
|
||||
unsafe impl Sync for Record {}
|
||||
// unsafe impl Send for Record {}
|
||||
// unsafe impl Sync for Record {}
|
||||
|
||||
impl TryFrom<&[u8]> for Record {
|
||||
type Error = &'static str;
|
||||
|
||||
fn try_from(record_bytes: &[u8]) -> Result<Self, Self::Error> {
|
||||
// Return an error if the slice length is less than 12
|
||||
if record_bytes.len() < 12 {
|
||||
return Err("Slice must be at least of length 12 to be converted into Record");
|
||||
if record_bytes.len() != 12 {
|
||||
return Err("Slice must be of length 12 to be converted into Record");
|
||||
}
|
||||
|
||||
// Extract the employee ID from the central 4 bytes of the record in
|
||||
@ -48,6 +48,7 @@ impl TryFrom<&[u8]> for Record {
|
||||
let datetime = u32::from_le_bytes(datetime);
|
||||
|
||||
// Return a new Record
|
||||
#[allow(clippy::cast_possible_wrap)]
|
||||
Ok(Self {
|
||||
employee_id,
|
||||
clock: match record_bytes[1] >> 6 {
|
||||
@ -55,7 +56,7 @@ impl TryFrom<&[u8]> for Record {
|
||||
1 => Clock::FirstOut,
|
||||
2 => Clock::SecondIn,
|
||||
3 => Clock::SecondOut,
|
||||
_ => panic!("Math has broken"),
|
||||
_ => unreachable!("Math has broken"),
|
||||
},
|
||||
datetime: Local
|
||||
.with_ymd_and_hms(
|
||||
@ -94,9 +95,9 @@ mod tests {
|
||||
datetime: Local
|
||||
.with_ymd_and_hms(1970, 1, 1, 0, 0, 0)
|
||||
.single()
|
||||
.unwrap(),
|
||||
.expect("Datetime is not unique!"),
|
||||
})
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
@ -106,7 +107,7 @@ mod tests {
|
||||
assert_eq!(
|
||||
record_bytes.try_into(),
|
||||
Err::<Record, &str>("Slice must be at least of length 12 to be converted into Record")
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
@ -116,6 +117,6 @@ mod tests {
|
||||
assert_eq!(
|
||||
record_bytes.try_into(),
|
||||
Err::<Record, &str>("DateTime conversion error")
|
||||
)
|
||||
);
|
||||
}
|
||||
}
|
||||
@ -17,7 +17,11 @@ impl<'a> RecordIterator<'a> {
|
||||
|
||||
// Calculate the sequence number on which the last record resides and
|
||||
// the index of the first `ff` byte, avoiding overflows
|
||||
let sequence_number = (total_records as u32 * 12 / 1024) as u16;
|
||||
//
|
||||
// TODO: Find a better way to do the multiplication and the division
|
||||
// avoiding overflows
|
||||
#[allow(clippy::cast_possible_truncation)]
|
||||
let sequence_number = (u32::from(total_records) * 12 / 1024) as u16;
|
||||
let first_useless_byte_index = total_records as usize * 12 % 1024;
|
||||
|
||||
// The endpoint expects the first block of records to be sent first
|
||||
Loading…
x
Reference in New Issue
Block a user