@@ -116,25 +116,25 @@ async def main():
116116
117117## Public Methods in TeslemetryStream Class
118118
119- ### ` __init__(self, session: aiohttp.ClientSession, access_token: str, server: str | None = None, vin: str | None = None, parse_timestamp: bool = False) `
119+ ### ` __init__(session: aiohttp.ClientSession, access_token: str, server: str | None = None, vin: str | None = None, parse_timestamp: bool = False) `
120120Initialize the TeslemetryStream client.
121121
122- ### ` get_vehicle(self, vin: str) -> TeslemetryStreamVehicle `
123- Create a vehicle stream .
122+ ### ` get_vehicle(vin: str) -> TeslemetryStreamVehicle `
123+ Create a vehicle object to manage config and create listeners .
124124
125- ### ` connected(self) -> bool `
125+ ### ` connected -> bool `
126126Return if connected.
127127
128- ### ` get_config(self, vin: str | None = None) -> None `
128+ ### ` get_config(vin: str | None = None) -> None `
129129Get the current stream config.
130130
131131### ` find_server(self) -> None `
132132Find the server using metadata.
133133
134- ### ` update_fields(self, fields: dict, vin: str) -> dict `
134+ ### ` update_fields(fields: dict, vin: str) -> dict `
135135Modify the Fleet Telemetry configuration.
136136
137- ### ` replace_fields(self, fields: dict, vin: str) -> dict `
137+ ### ` replace_fields(fields: dict, vin: str) -> dict `
138138Replace the Fleet Telemetry configuration.
139139
140140### ` config(self) -> dict `
@@ -146,82 +146,35 @@ Connect to the telemetry stream.
146146### ` close(self) -> None `
147147Close connection.
148148
149- ### ` async_add_listener(self, callback: Callable, filters: dict | None = None) -> Callable[[], None] `
149+ ### ` async_add_listener(callback: Callable, filters: dict | None = None) -> Callable[[], None] `
150150Add listener for data updates.
151151
152152### ` listen(self) `
153153Listen to the telemetry stream.
154154
155- ### ` listen_Credits(self, callback: Callable[[dict[str, str | int]], None]) -> Callable[[], None] `
155+ ### ` listen_Credits(callback: Callable[[dict[str, str | int]], None]) -> Callable[[], None] `
156156Add listener for credit events.
157157
158- ### ` listen_Balance(self, callback: Callable[[int], None]) -> Callable[[], None] `
158+ ### ` listen_Balance(callback: Callable[[int], None]) -> Callable[[], None] `
159159Add listener for credit balance.
160160
161161## Public Methods in TeslemetryStreamVehicle Class
162162
163- ### ` __init__(self, stream: TeslemetryStream, vin: str) `
163+ ### ` __init__(stream: TeslemetryStream, vin: str) `
164164Initialize the TeslemetryStreamVehicle instance.
165165
166166### ` get_config(self) -> None `
167167Get the current vehicle config.
168168
169- ### ` update_fields(self, fields: dict) -> dict `
169+ ### ` update_fields(fields: dict) -> dict `
170170Update Fleet Telemetry configuration for the vehicle.
171171
172- ### ` replace_fields(self, fields: dict) -> dict `
172+ ### ` replace_fields(fields: dict) -> dict `
173173Replace Fleet Telemetry configuration for the vehicle.
174174
175175### ` config(self) -> dict `
176176Return current configuration for the vehicle.
177177
178178### ` listen_* ` Methods
179- The ` TeslemetryStreamVehicle ` class contains several ` listen_* ` methods for various telemetry signals. These methods allow you to listen to specific signals and handle their data in a type-safe manner. The available ` listen_* ` methods and their callback types are:
180-
181- - ` listen_BatteryLevel(callback: Callable[[int], None]) `
182- - ` listen_VehicleSpeed(callback: Callable[[int], None]) `
183- - ` listen_Location(callback: Callable[[dict], None]) `
184- - ` listen_ChargeState(callback: Callable[[str], None]) `
185- - ` listen_DoorState(callback: Callable[[dict], None]) `
186- - ` listen_HvacPower(callback: Callable[[str], None]) `
187- - ` listen_ClimateKeeperMode(callback: Callable[[str], None]) `
188- - ` listen_CabinOverheatProtectionMode(callback: Callable[[str], None]) `
189- - ` listen_DefrostMode(callback: Callable[[str], None]) `
190- - ` listen_SeatHeaterLeft(callback: Callable[[int], None]) `
191- - ` listen_SeatHeaterRight(callback: Callable[[int], None]) `
192- - ` listen_SeatHeaterRearLeft(callback: Callable[[int], None]) `
193- - ` listen_SeatHeaterRearRight(callback: Callable[[int], None]) `
194- - ` listen_SeatHeaterRearCenter(callback: Callable[[int], None]) `
195- - ` listen_SentryMode(callback: Callable[[bool], None]) `
196- - ` listen_ScheduledChargingMode(callback: Callable[[str], None]) `
197- - ` listen_ScheduledChargingPending(callback: Callable[[bool], None]) `
198- - ` listen_ScheduledChargingStartTime(callback: Callable[[str], None]) `
199- - ` listen_ScheduledDepartureTime(callback: Callable[[str], None]) `
200- - ` listen_SoftwareUpdateVersion(callback: Callable[[str], None]) `
201- - ` listen_SoftwareUpdateDownloadPercentComplete(callback: Callable[[int], None]) `
202- - ` listen_SoftwareUpdateExpectedDurationMinutes(callback: Callable[[int], None]) `
203- - ` listen_SoftwareUpdateInstallationPercentComplete(callback: Callable[[int], None]) `
204- - ` listen_SoftwareUpdateScheduledStartTime(callback: Callable[[str], None]) `
205- - ` listen_ChargingCableType(callback: Callable[[str], None]) `
206- - ` listen_FastChargerType(callback: Callable[[str], None]) `
207- - ` listen_ChargePort(callback: Callable[[str], None]) `
208- - ` listen_ChargePortLatch(callback: Callable[[str], None]) `
209- - ` listen_ChargePortDoorOpen(callback: Callable[[bool], None]) `
210- - ` listen_ChargeEnableRequest(callback: Callable[[bool], None]) `
211- - ` listen_ChargeCurrentRequest(callback: Callable[[int], None]) `
212- - ` listen_ChargeCurrentRequestMax(callback: Callable[[int], None]) `
213- - ` listen_ChargeAmps(callback: Callable[[int], None]) `
214- - ` listen_ChargerPhases(callback: Callable[[int], None]) `
215- - ` listen_ChargeLimitSoc(callback: Callable[[int], None]) `
216- - ` listen_ChargeState(callback: Callable[[str], None]) `
217- - ` listen_ChargingCableType(callback: Callable[[str], None]) `
218- - ` listen_FastChargerType(callback: Callable[[str], None]) `
219- - ` listen_ChargePort(callback: Callable[[str], None]) `
220- - ` listen_ChargePortLatch(callback: Callable[[str], None]) `
221- - ` listen_ChargePortDoorOpen(callback: Callable[[bool], None]) `
222- - ` listen_ChargeEnableRequest(callback: Callable[[bool], None]) `
223- - ` listen_ChargeCurrentRequest(callback: Callable[[int], None]) `
224- - ` listen_ChargeCurrentRequestMax(callback: Callable[[int], None]) `
225- - ` listen_ChargeAmps(callback: Callable[[int], None]) `
226- - ` listen_ChargerPhases(callback: Callable[[int], None]) `
227- - ` listen_ChargeLimitSoc(callback: Callable[[int], None]) `
179+ The ` TeslemetryStreamVehicle ` class contains a ` listen_* ` methods for each telemetry signal.
180+ These methods allow you to listen to specific signals and handle their data in a type-safe manner.
0 commit comments