Package: pyaussiebb
pyAussieBBThis is a very simple module for interacting with the Aussie Broadband APIs.Usagepipinstall--userpyaussiebb
python
>>>fromaussiebbimportAussieBB
>>>account=AussieBB(username,password)>>>account.get_services()[{allyourservicedetails}]For more, check out the docs.AsyncIO versionYou can replacefrom aussiebb import AussieBBwithfrom aussiebb.asyncio import AussieBBand you'll get anaiohttp-powered version. The only difference in this case is that you have to explicitly calllogin()for reasons.If you hit the rate limit it'll raise aRateLimitexception. I haven't put that functionality into the blocking version yet, since ... that tends not to hit it. 🤣DevelopmentExample service tests I've seenAll the "endpoints" below should be tacked ontoaussiebb.const.BASEURL['api'].Warning:/nbn/{service_id}/connectionseems to have both a GET and POST method endpoint - tests on other endpoints may be similar.These can be run by usingAussieBB.run_test()with the string after the last forward-slash as the "test" - ie,connectionorlinestate.HFCThese are entirely untested so far.EndpointMethodNameDescription/nbn/{service_id}/connectionProbably GETCheck ConnectionCheck to see if your service is currently connected/nbn/{service_id}/connectionProbably POSTKick ConnectionKick your current session and force your device to reauthenticate/tests/{service_id}/loopbackProbably POSTLoopback TestThis will test the connectivity between the point NBN’s network transitions to ours and to the closest point to your property. Usually either the Network Termination Device or Node./tests/{service_id}/ntdstatusProbably POSTNTD StatusAn NTD Status will show you the operational state of the Network Termination Device (NTD). The test will also show if the NTD is detecting the wired connection from your router.FTTCEndpointMethodNameDescription/nbn/{service_id}/connectionGETCheck ConnectionCheck to see if your service is currently connected/nbn/{service_id}/connectionProbably POSTKick ConnectionKick your current session and force your device to reauthenticate/tests/{service_id}/dpuportresetProbably POSTDPU Port ResetReset the Port on the DPU (Distribution Point Unit) along with clearing any errors that maybe causing issues with connectivity./tests/{service_id}/dpuportstatusPOSTDPU Port StatusA DPU (Distribution Point Unit) port status will show if the NCD (Network Connection Device) is providing power to the DPU. It will also state if the NCD (Network Connection Device) is in sync./tests/{service_id}/dpustatusPOSTDPU StatusThis will provide if the DPU (Distribution Point Unit) is currently being powered./tests/{service_id}/loopbackPOSTLoopback TestThis will test the connectivity between the point NBN’s network transitions to ours and to the closest point to your property. Usually either the Network Termination Device or Node./tests/{service_id}/ncdportresetProbably POSTNCD Port ResetReset the gateway port on your NCD (Network Connection Device)./tests/{service_id}/ncdresetProbably POSTNCD ResetThis will remotely restart your Network Termination Device.FTTNEndpointMethodNameDescription/nbn/{service_id}/connectionGETCheck ConnectionCheck to see if your service is currently connected/nbn/{service_id}/connectionProbably POSTKick ConnectionKick your current session and force your device to reauthenticate/tests/{service_id}/linestatePOSTLine StateA line state test will determine if you have “sync” (connection) to the node. If the service is in sync this test will also return your maximum and current attainable transfer rate./tests/{service_id}/loopbackPOSTLoopback TestThis will test the connectivity between the point NBN’s network transitions to ours and to the closest point to your property. Usually either the Network Termination Device or Node./tests/{service_id}/portresetProbably POSTPort ResetThis will reset the connection from the Node and also clear errors that may be causing issues with gaining sync./tests/{service_id}/stabilityprofileProbably POSTStability ProfileThis will apply changes to your FTTN service including allowing increased noise to occur before making the connection unstable. This will cause your speeds to degrade as a result, but in turn making the service more stable. For NBN to investigate a fault this profile needs to be applied and a minimum of 5 dropouts recorded over a 24hr period on NBN's systems before a dropout fault can be raisedFTTPThese are as-yet untested.EndpointMethodNameDescription/nbn/{service_id}/connectionProbably GETCheck ConnectionCheck to see if your service is currently connected/nbn/{service_id}/connectionProbably POSTKick ConnectionKick your current session and force your device to reauthenticate/tests/{service_id}/loopbackProbably POSTLoopback TestThis will test the connectivity between the point NBN’s network transitions to ours and to the closest point to your property. Usually either the Network Termination Device or Node./tests/{service_id}/portresetProbably POSTPort ResetThis will reset the connection from the Node and also clear errors that may be causing issues with gaining sync./tests/{service_id}/unidstatusProbably POSTUNI-D StatusUNI-D Status will show if the UNI-D port you are currently using has a router connected to it. This will also provide the Link speed your router and UNI-D port are connected at Eg, 100mbit or 1gbit. You will also see the MAC address of the currently connected router.ChangelogSeeCHANGELOG.md