# fnnas-api

**Repository Path**: gitee_fansenlin/fnnas-api

## Basic Information

- **Project Name**: fnnas-api
- **Description**: fnnas api 仓库
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-04-07
- **Last Updated**: 2026-04-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

目前已经实现ws断开自动重连（会重新登录）

#### 快速入门
> Linux、Macos设置环境变量
```shell
export fn_username=你的账号
export fn_password=你的密码
```

> Windows设置环境变量
```cmd
set fn_username=你的账号
set fn_password=你的密码
```


> 示例代码
```python
import asyncio
from sdk import FnOsClient
from sdk.handlers import HandlerUserInfo
import os


async def main():
    # 启动飞牛连接
    client = FnOsClient(ping_interval=60)
    await client.connect('ws://127.0.0.1:5666/websocket?type=main')
    client.add_handler('user.info', HandlerUserInfo)

    try:
        login_res = await client.login(os.getenv("fn_username"), os.getenv('fn_password'))
        print("login_res", login_res)
        res = await client.user_info()
        print("user_info", res)
        res = await client.authToken() # 非必须
        print("authToken", res)
        
        # 上传文件 上传时修改sdk中的链接地址  懒得写配置项了
        local_path = r'C:\Users\Administrator\Pictures\bg.jpg'
        nas_path = f'vol1/1001/tmp_img/bg.jpg' # NAS绝对路径
        res = await client.upload(local_path, nas_path)
        print("upload res", res)

        # 修改端口
        res = await client.setting_port()
        print("setting_port", res)

        # 永久运行（直到手动停止）
        await asyncio.Event().wait()

        # 运行60s停止
        # await asyncio.sleep(60)
        # await client.close()
    except KeyboardInterrupt:
        print('中断进程')
        print('关闭client')
        await client.close()


if __name__ == "__main__":
    asyncio.run(main())
```

#### 关闭日志输出

> 默认日志输出为DEBUG等级，如果需要关闭日志输出，可以参考下面代码

```python
import asyncio
import logging
from sdk import FnOsClient
import os

async def main():
    # 启动飞牛连接
    client = FnOsClient(ping_interval=60, logger=logging.getLogger("null"))
    await client.connect('ws://192.168.31.8:5666/websocket?type=main')
    login_res = await client.login(os.getenv("fn_username"), os.getenv('fn_password'))
    print(login_res)

if __name__ == "__main__":
    asyncio.run(main())
```

SDK没有优化，很多异常没有处理，只是能用，不好用。大佬们封装吧

#### TODO

 - [x] 登录
 - [x] 验证Token
 - [x] 心跳
 - [x] 用户详细信息
 - [x] 文件列表
 - [x] 文件上传
 - [x] 端口修改
 - [x] 磁盘信息
 - [x] 搜索文件
 - [ ] 文件下载
 - [ ] 文件双向同步 [我改了SMB方案，所以可能不更新了]
 - [ ] 其他接口