@@ -4,14 +4,14 @@ This document details the functions available in the `slicks` package.
44
55## Core Functions
66
7- ### ` slicks.connect_influxdb3 `
7+ ### ` slicks.connect_timescaledb `
88
9- Updates the global InfluxDB connection settings dynamically.
9+ Updates the global TimescaleDB connection settings dynamically.
1010
1111``` python
12- slicks.connect_influxdb3( url = None , token = None , org = None , db = None )
12+ slicks.connect_timescaledb( dsn = None , None , org = None , table = None )
1313```
14- - ** url** * (str)* : The InfluxDB host URL (e.g., ` "http://localhost:8086" ` ).
14+ - ** url** * (str)* : The TimescaleDB host URL (e.g., ` "http://localhost:8086" ` ).
1515- ** token** * (str)* : Authentication token.
1616- ** org** * (str)* : Organization name (default: ` "Docs" ` ).
1717- ** db** * (str)* : Database/Bucket name (default: ` "WFR25" ` ).
@@ -30,7 +30,7 @@ slicks.fetch_telemetry(start_time, end_time, signals=None, client=None,
3030- ** start_time** * (datetime)* : Start of the query range.
3131- ** end_time** * (datetime)* : End of the query range.
3232- ** signals** * (str or list[ str] )* : A single sensor name or a list of sensor names to fetch. Defaults to standard configuration if ` None ` .
33- - ** client** * (InfluxDBClient3 , optional)* : An existing client instance (advanced use).
33+ - ** client** * (TimescaleDBClient3 , optional)* : An existing client instance (advanced use).
3434- ** filter_movement** * (bool)* : If ` True ` (default), strips out rows where the car is stationary.
3535- ** resample** * (str or None)* : Pandas frequency string for resampling (e.g. ` "1s" ` , ` "100ms" ` ). Pass ` None ` for raw data.
3636- ** schema** * (str)* : ` "wide" ` (default, columnar — each signal is a column) or ` "narrow" ` (legacy EAV — requires pivot).
@@ -105,13 +105,13 @@ slicks.detect_movement_ratio(df, speed_column="INV_Motor_Speed")
105105
106106### ` slicks.WideWriter `
107107
108- Encodes CAN frames to InfluxDB wide format line protocol and writes them in batches.
108+ Encodes CAN frames to TimescaleDB wide format line protocol and writes them in batches.
109109
110110``` python
111111from slicks import WideWriter
112112
113113writer = WideWriter(
114- url, # InfluxDB URL
114+ url, # TimescaleDB URL
115115 token, # Auth token
116116 bucket, # Bucket/database name (e.g. "WFR26")
117117 measurement, # Measurement name (e.g. "WFR26")
@@ -154,7 +154,7 @@ frame = decode_frame(db, can_id, raw_bytes) # → DecodedFrame or None
154154
155155### ` slicks.frame_to_line_protocol `
156156
157- Converts a ` DecodedFrame ` to an InfluxDB line protocol string.
157+ Converts a ` DecodedFrame ` to an TimescaleDB line protocol string.
158158
159159``` python
160160from slicks import frame_to_line_protocol
0 commit comments