Skip to content

Latest commit

 

History

History
285 lines (252 loc) · 7.33 KB

README.md

File metadata and controls

285 lines (252 loc) · 7.33 KB
Raw

Auto

A auto layout library for Hekr html5 page

Build Setup

# install dependencies
npm install

# serve with hot reload at localhost:8080
npm run dev

# build for production with minification
npm run build

# build for production and view the bundle analyzer report
npm run build --report

# Auto class library unit test
npm run test

开发文档

http://10.1.1.6:3200/#/

使用说明

  1. npm install @hekr/auto --save
  2. npm install @hekr/hekr-components --save
  3. npm install @hekr/hekr-h5-sdk --save
  4. 引入组件并全局安装
import Vue from 'vue'
import App from './App'
import store from './store'
import Auto from '@hekr/auto'
import { Hekr, Matrix } from '@hekr/hekr-h5-sdk'
import HekrComponents from '@hekr/hekr-components'

if (process.env.NODE_ENV !== 'production') {
  const keys = require('../keys.json')

  window.Matrix = new Matrix(keys)
}

Vue.prototype.$hekr = window.$hekr = new Hekr({
  query: {
    auto: false
  }
})

// 确保被安装，否则Auto无法正常运行
Vue.use(HekrComponents)
// 安装library中包含的组件
Vue.use(Auto, {
  // 必须传入一个函数，不要直接写this.$hekr.send，这样会导致send函数内部this指向错误
  send: val => $hekr.send(val),
  delay: 500, // 命令发送时，节流延时时间，默认值为500
  /*
  * 要过滤掉的参数，即在模板中已经编写了的组件
  * 也可以在getComponents执行后调用filter去过滤
  */
  filter: ['sw', 'light']
})

new Vue({
  el: '#app',
  store,
  template: '<App/>',
  components: { App }
})
  1. 初始化Auto(App.vue)
<template lang="pug">
.app
  hk-header(
    title="测试设备",
    right-icon="iconfont icon-gengduo",
    @click-left="goback",
    border
  )
  .app-container
    //- 这里可以放其他的已经编写了在模板中的参数的组件
    component(
      v-for="(item, index) in components",
      v-if="item",
      :key="index",
      :is="item.name",
      v-bind="item.props",
      v-on="item.events"
    )
</template>

<script>
export default {
  name: 'app',
  data () {
    return {
      state: {} // 存储状态信息
    }
  },
  computed: {
    components () {
      return this.$auto.getComponents(this.state)
    }
  },
  mounted () {
    this.$hekr.ready(() => {
      this.$i18n.use(this.$hekr.app.lang)
      this.$auto.set({
        lang: this.$hekr.app.lang,
        ui: this.$hekr.i18nUI.ui,
        i18n: this.$hekr.i18nUI.i18n,
        protocol: this.$hekr.template.protocol
      })
      // 这里可以根据key遍历过滤掉已经写在模板中的组件
      this.components = this.$auto.getComponents(this.state)
      this.$hekr.on('devSend', data => {
        const state = {...this.state}
        Object.keys(data).forEach(key => {
          state[key] = data[key]
        })
        this.state = state
      })

    })
  }
}
</script>

<style lang="stylus">
import "~@hekr/auto/dist/auto.css"
</style>

UI显示配置项目

[
   {
    key: temp
    component: 组件名称，
    visible: true/false
  }
]

语言配置

{
  temp: {
    zh_CN: {
      name: "开关",
      unit: '',
      keys:{
        0: 关,
        1: 开
      }
    },
    en_US: {
      name: "switch",
      unit: '',
      keys:{
        0: off,
        1: on
      }
    }
  }
}

开发说明

  1. 开发新的组件都放在src/components文件夹下对应的type文件夹中，每一个组件对应一个文件夹
  2. 组件命名方式采用**auto-[type]-[name]**的方式，其中type表示组件类型，name是具体的名称，如auto-bool-switch表示bool类型的switch组件
  3. 每一个具体的组件文件夹下都有一个index.js文件，其中导出一个对象，大致内容如下
import Switch from './switch.vue'

export default {
  name: Switch.name, // 组件名称
  title: '开关', // 组件的标题
  type: 'bool', // 组件类型
  // 获取组件的配置参数
  // options 配置信息
  // state 组件当前状态值，是在this.auto.getComponents(this.state)传入的参数
  get (options, state) {
    return {
      // 组件需要的props参数
      props: {
        title: options.name,
        value: value === undefined ? false : !!value, // 计算出组件的值
        disabled: !options.mode.w
      },
      // 组件要监听的事件
      events: {
        input (val) {
          if (options.mode.w) {
            // 返回命令，这里返回去之后会被Auto类初始化时传进来的send函数发送到云端
            // 下发命令一定要保证有cmdTag
            return {
              cmdTag: options.cmdTag,
              [option.key]: val ? 1 : 0
            }
          }
        }
      }
    }
  },
  install (Vue) { // Vue.use安装组件的方法
    Vue.component(Switch.name, Switch)
  }
}
  1. 组件vue文件编写和其他普通vue组件编写没有任何区别，只是要注意对其进行合理的封装，所需的参数和index.js文件互相对应即可

Auto类

初始化

const $auto = new Auto ({
  ui = [], // ui配置信息
  lang = 'en-US', // 语言
  i18n = {}, // 语言包
  send = () => { }, // 发送命令的函数
  delay = 500, // 命令发送节流
  filter = [], // 筛选数组，去掉模板中已经编写的
  protocol = {} // 协议
})

属性

名称 类型 说明
options object 类的相关配置参数
cmds object 以cmdTag为键的对象集合
components object 各种类型的参数所对应的组件
i18n object 当前语言配置
parameter array 每一项为经过抽象的参数，包含参数类型、名称、标识符、取值范围、关联下发命令等参数
defaultState object 所有参数的默认状态

方法

名称 说明 参数 返回值
get 获取指定参数的配置，属性以.分割， 如获取sw参数的mode的w的属性值，可写为get('sw.mode.w') 参数标识符 parameter中某一项
set 设置更新内部的配置 {ui, lang, i18n, send, delay, filter, protocol} -
has 指定参数是否存在于协议中 参数标识符 true/false
visible 返回指定参数是否显示，如参数列表中没有这个参数就返回false 参数标识符 true/false
disabled 返回指定参数是否不可下发命令，如参数返回visible为false，就返回true，否则就读取mode.w属性 参数标识符 true/false
use 安装扩展组件，安装之前必须确保组件已经被全局安装 组件数组或单个组件 -

组件配置如下

import Switch from './switch.vue'

export default {
  name: Switch.name,
  title: '开关',
  type: 'bool',
  get (options, value) {
    return {
      props: {
        title: options.name,
        value: value === undefined ? false : !!value,
        disabled: !options.mode.w
      },
      events: {
        input (val) {
          if (options.mode.w) {
            return {
              cmdTag: options.cmdTag,
              [options.key]: val ? 1 : 0
            }
          }
        }
      }
    }
  }
}